Documentation des API

Hitflow met à votre disposition des API permettant l'utilisation et l'intégration de notre service de montoring dans des outils développés par vos soins.
Pour permettre un accès sécurisé aux données de votre compte, sans divulguer votre identifiant et votre mot de pas personnels, nos APIs utilisent un système de clé d'authentification. Ce jeu de clés permet la génération de jetons de session unique qui sont utilisés pour effectuer des requêtes avec nos APIs.

  • Sommaire

Généralités

Le protocole de l'API Hitflow utilise les méthodes GET, POST, DELETE et PUT.

L'URL d'accès est https://wapi.hitflow.net auquel est ajouté le chemin vers l'API ciblée par exemple :
https://wapi.hitflow.net/v1/user/infos

Si des données doivent être envoyées dans la requête (cas d'une requête POST ou PUT), le format accepté par l'API est “application/x-www-form-urlencoded”.

Les réponses de l'API sont toujours au format JSON avec au moins un attribut “error” contenant un entier permettant de renseigner sur l'état de la requête.

{
 "error": 0,
}

Authentification par jeton

L'utilisation des API se fait à l'aide d'un jeton de session passé dans l'entête des requêtes. Pour générer ce jeton, il faut faire un appel à l'API “auth/credential” en utilisant deux clés créées au préalable depuis votre manager.

Création des clés d'authentification

Connectez-vous à votre manager puis rendez-vous dans l'onglet “l'API” de la rubrique “Paramètres” depuis le menu de navigation.

  1. Depuis cette liste, cliquez sur le bouton Ajouter une clé pour ouvrir le formulaire de création d'un nouvel accès.
  2. Définissez un nom qui vous permettra d'identifier facilement l'application utilisant votre clé d'accès puis validez.
  3. Après quelques instants, vous verrez apparaître une nouvelle clé dans la liste.
  4. Vous devez activer cette clé en cliquant sur le bouton avant de pouvoir l'utiliser dans votre application.

Génération d'un jeton de session

Maintenant que vous avez créé la clé d'application et la clé secrète dans votre manager, vous allez pouvoir les utiliser pour générer un jeton de session.

La génération d'un jeton de session se fait depuis cette URL https://wapi.hitflow.net/v1/auth/credential en envoyant deux paramètres : app_key et secret_key.

Exemple d'une requête générant un jeton

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" https://wapi.hitflow.net/v1/auth/credential -d "app_key=xxxxxxxxxxxxxxxx&secret_key=xxxxxxxxxxxxxxxxxxxxxxxx"

En cas de réussite, l'API retournera une réponse de cette forme :

{
 "error": 0,
 "token": "57ab2c78beb7f5b6b29a68f1f0ff30de3eaf7b46fc6fcf4d420ed10321faa4ff",
 "account": "5ccxxxxxxxxxxxxxxxxxxxxx"
}

Attributs de la réponse :

  • error : la valeur 0 indique la réussite de la requête.
  • token : contiens la chaine de caractère unique permettant l'authentification.
  • account : représente l'identifiant unique de votre compte.

Utilisation du jeton de session

Le jeton de session généré doit être envoyé dans l'entête de la requête via l'attribut :

HitFlow-Token-Access

Exemple d'une requête utilisant le jeton de session

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/user/infos

L'API retournera les informations liées au compte comme l'exemple ci-dessous :

{
 "error": 0,
 "infos": {
  "id": "5ccxxxxxxxxxxxxxxxxxxxxx",
  "time_create": 1556219006, "email": "hello@hitflow.net",
  "lastname": "Hitflow",
  "firstname": null,
  "language": "en_US.utf8",
  "timezone": "Europe\/Paris",
  "ads_news": true,
  "ads_dev": true,
  "accounts": {
   "5ccxxxxxxxxxxxxxxxxxxxxx": {
    "name": "My Account",
    "enabled": true
   }
  },
  "validated": true,
  "wizard_onstartup": false
 }
}

Expiration d'un jeton de session

Un jeton de session est automatiquement désactivé après 600 secondes d'inactivités. Lorsqu'un jeton invalide est utilisé, l'API retournera systématiquement le message suivante :

{
 "error":10000,
 "msg":"Unauthorized."
}

Tableau de bord

GET/v1/dashboard

Retourne les informations permettant l'affichage du dashboard dans le manager.

Entêtes

  • HitFlow-Token-Access : Token de session

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/dashboard

Exemple de réponse

{ "error": 0, "online": { "count" => 0, "list" => {} }, "disabled": { "count" => 0, "list" => {} }, "error": { "count" => 0, "list" => {} } }

Disponibilités

POST/v1/uptimes/search

Retourne la liste des tests de disponibilités du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

query

Type :Chaîne de caractère

Description :

Chaîne de caractères contenant les termes de recherche à trouver dans la liste.

Obligatoire :Non

Valeur par défaut :-

status

Type :Tableau

Description :

Tableau d'entier permettant de limiter l'affichage des entrées :

  • 1 : le statut est "désactivée"
  • 2 : le statut est "erreur"
  • 3 : le statut est "en ligne"
  • 4 : le statut est "inconnu"

Obligatoire :Non

Valeur par défaut :-

types

Type :Tableau

Description :

Tableau contenant les types d'entrées à afficher dans la liste.
Les valeurs possibles sont : icmp, tcp, udp, http, https, ftp, ws

Obligatoire :Non

Valeur par défaut :-

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptimes/search

Exemple de réponse

{ "error": 0, "count": 1, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "icmp", "time_create": 1556228110, "time_enable": 1582732121, "time_disable": 1582513563, "time_down": 1585491752, "time_up": 1585491830, "name": "Uptime Test", "status": 0, "enable": true, "check_rate": "300", "response_uptime": 100, "host": "xxx.xxx.xxx.xxx", "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 } } }

GET/v1/uptime/{id}

Retourne les informations relatives au test de disponibilité du service.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "type": "https", "time_create": 1556224073, "time_update": 1585670858, "time_enable": 1582732121, "time_disable": 1582513563, "time_down": 1578452985, "time_up": 1582732139, "time_delete": null, "time_lastcheck": 1585670858, "time_nextcheck": 1585670918, "name": "Uptime Test", "status": 0, "enable": true, "check_rate": "60", "check_timeout": "30", "response_time_limit": "30000", "check_countries": ["FR", "GB", "PL", "CA", "US", "SG", "AU"], "alert_contacts": [ "5ccxxxxxxxxxxxxxxxxxxxxx" ], "alert_after": "0", "alert_onbackup": true, "response_time_avg": 1427.33, "response_time_avg_checkers": { "uk-eoh1she": 1025.16, ... }, "response_uptime": 100, "response_uptime_checkers": { "uk-eoh1she": 100, ... }, "response_data": { "1585587600": { "success": 49, "error": 0, "time": 84004, "time_count": 49, "checkers": { "uk-eoh1she": { "success": 4, "error": 0, "time": 8909, "time_count": 4 }, ... } }, ... }, "host": "example.hitflow.net", "port": "443", "path": "\/", "auth_username": null, "auth_password": null, "check_ssl_error": "true", "headers": null, "post_data": null, "words_contains": null, "words_notcontains": null, "http_status_code": ["204", "205", "206", "303", "400", "401", "403", "404", "405", "406", "408", "410", "413", "444", "429", "494", "495", "496", "499", "500", "501", "502", "503", "504", "505", "506", "507", "508", "509", "510", "511", "520", "521", "522", "523", "524", "598", "599"], "check_error": true, "request_data": null, "request_method": "get" } }

PUT/v1/uptime/{id}/enable

Active ou désactive le test de disponibilité d'un service.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=false"

Exemple de réponse

{ "error": 0, "status": false, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/uptime/{id}

Supprime le test de disponibilité du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error":0 }

POST/v1/uptime/{id}/interval

Change l'intervalle de contrôle pour le test dont l'identifiant est passé dans l'URL.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

interval

Type :Entier

Description :

L'intervalle doit être une des valeurs suivantes : 60, 300, 600, 1800, 3600.

Obligatoire :Non

Valeur par défaut :300

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/5ccxxxxxxxxxxxxxxxxxxxxx/interval -d "interval=3600"

Exemple de réponse

{ "error": 0, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

POST/v1/uptime/reports/requests

Retourne une liste des tests effectué sur un service suivant un intervalle de temps.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément.

Obligatoire :Oui

Valeur par défaut :-

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :200

time_begin

Type :Entier

Description :

Date de début de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :yesterday midnight

time_end

Type :Entier

Description :

Date de fin de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :today midnight

probes

Type :Tableau

Description :

Tableau contenant le code des sondes.

Obligatoire :Non

Valeur par défaut :NULL

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/reports/requests -d "id= 5ccxxxxxxxxxxxxxxxxxxxxx&time_begi=1585612800&time_end=1585699199"

Exemple de réponse

{ "error": 0, "time_begin": 1585612800, "time_end": 1585695600, "days": 0.999988425925926, "preset": "hourly", "requests": { "data": { "count": 440, "success": 988, "error": 12 }, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "hit_type": "icmp", "time_create": 1585752094, "time_day": 1585699200, "report": { "error": "0", "status": "0", "version": "1", "host": "xxx.xxx.xxx.xxx", "count": "5", "transmitted": "5", "received": "5", "loss": "0", "time": "4000", "min": "332.146", "avg": "622.926", "max": "720.636", "mdev": "148.582" }, "checker": { "code": "fr-ceesh0i", "name": "Strasbourg 1", "continent": "EU", "country": "FR", "city": "Strasbourg" }, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, ... } } }

GET/v1/uptime/reports/request/{id}

Retourne les informations spécifiques d'un test effectué sur un service.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/reports/request/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "time": 1585736990, "type": "https", "report": { "error": "0", "status": "0", "version": "1", "host": "https:\/\/hitflow.net:443\/", "timeout": "30", "http_code": "200", "http_header": "GET \/ HTTP\/1.1\r\nHost: hitflow.net\r\nUser-Agent: Mozilla\/5.0+(compatible; HitFlow\/1.0\/5ccxxxxxxxxxxxxxxxxxxxxx; https:\/\/hitflow.net\/)\r\nAccept: *\/*\r\nHitFlow-Reference: 5ccxxxxxxxxxxxxxxxxxxxxx", "http_method": "GET", "namelookup_time": "61", "connect_time": "4", "tls_handshake_time": "49", "response_time": "1856", "total_time": "1970", "redirect_url": "0", "data_size": "57397", "curl_errno": "0" }, "checker": { "code": "uk-eoh1she", "name": "London 1", "continent": "EU", "country": "GB", "city": "London" } }

POST/v1/uptime/reports/alerts

Retourne une liste des alertes envoyées pour un service suivant un intervalle de temps.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément.

Obligatoire :Oui

Valeur par défaut :-

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :200

time_begin

Type :Entier

Description :

Date de début de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :yesterday midnight

time_end

Type :Entier

Description :

Date de fin de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :today midnight

probes

Type :Tableau

Description :

Tableau contenant le code des sondes.

Obligatoire :Non

Valeur par défaut :NULL

fullcontent

Type :Booléen

Description :

Paramètre permettant de retourner toutes les informations (true) ou limiter à l'essentiel (false).

Obligatoire :Non

Valeur par défaut :false

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/reports/alerts -d "id= 5ccxxxxxxxxxxxxxxxxxxxxx&time_begin=1585612800&time_end=1585699199"

Exemple de réponse

{ "error": 0, "time_begin": 1585612800, "time_end": 1585782000, "days": 1.999988425925926, "preset": "hourly", "alerts": { "count": 20, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "telegram", "time_create": 1585746140, "hit_status": "0", "to": "XXXX XXXXX \/\/ @XXXXXX [999999999]", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "email", "time_create": 1585746140, "hit_status": "0", "to": "hello@hitflow.net", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "slack", "time_create": 1585746140, "hit_status": "0", "url": "https:\/\/hooks.slack.com\/services\/XXXXXXXXX\/XXXXXXXXX\/XXXXXXXXXXXXXXXXXXXXXXXX", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, ... } } }

GET/v1/uptime/reports/alert/{id}

Retourne les informations spécifiques d'une alerte envoyée à propos d'un service.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/uptime/reports/alert/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "time": 1585659291, "type": "telegram", "hit_status": "0", "content": { "error": "0", "message": "Nous ne d\u00e9tectons actuellement plus de probl\u00e8me sur le service \"Test Name\" (icmp:\/\/xxx.xxx.xxx.xxx).\n\nLa perturbation que nous avons constat\u00e9 \u00e9tait d'une dur\u00e9e de 3 minutes 55 secondes." }, "to": "XXXXXXXX \/\/ @xxxxxxx [999999999]" }

Serveurs

POST/v1/servers/search

Retourne la liste des serveurs à surveiller du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

query

Type :Chaîne de caractère

Description :

Chaîne de caractères contenant les termes de recherche à trouver dans la liste.

Obligatoire :Non

Valeur par défaut :-

status

Type :Tableau

Description :

Tableau d'entier permettant de limiter l'affichage des entrées :

  • 1 : le statut est "désactivée"
  • 2 : le statut est "erreur"
  • 3 : le statut est "en ligne"
  • 4 : le statut est "inconnu"

Obligatoire :Non

Valeur par défaut :-

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/servers/search

Exemple de réponse

{ "error": 0, "count": 2, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow Api", "status": 0, "enable": true, "time_lastping": 1588458048, "remote_addr": "xxx.xxx.xxx.xxx", "system_os": "linux", "system_uptime": 5429821, "load_average": 1.41, "total_cpu_usage": 99, "total_ram_usage": 84.16, "total_storage_usage": 47.37, "network_usage_rx": 0, "network_usage_tx": 0, "threshold_avg": "5", "threshold_cpu": "0", "threshold_ram": "90", "threshold_disk": "80", "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow Website", "status": 0, "enable": true, "time_lastping": 1588458042, "remote_addr": "xxx.xxx.xxx.xxx", "system_os": "linux", "system_uptime": 5429745, "load_average": 0.35, "total_cpu_usage": 99.02, "total_ram_usage": 39.79, "total_storage_usage": 42.11, "network_usage_rx": 0, "network_usage_tx": 0, "threshold_avg": "5", "threshold_cpu": "0", "threshold_ram": "80", "threshold_disk": "80", "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 } } }

GET/v1/server/{id}

Retourne les informations relatives au serveur à surveiller.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "type": null, "time_create": 1561407103, "time_update": 1583307253, "time_enable": 1582732108, "time_disable": 1582513564, "time_down": 1586869216, "time_up": 1586869532, "time_delete": null, "name": "Hitflow Website", "status": 0, "enable": true, "alert_onbackup": true, "auth_token": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", "time_lastping": 1588458332, "time_lastping_timeout": 1588458992, "remote_addr": "xxx.xxx.xxx.xxx", "system_os": "linux", "system_uptime": 5430045, "load_average": 0.42, "total_cpu_usage": 39.15, "total_ram_usage": 39.64, "total_swap_usage": 0, "total_storage_usage": 42.11, "network_usage_rx": 0, "network_usage_tx": 0, "process_list": [ ["systemd", "root", 0, 9, 0.46], ["kthreadd", "root", 0, 0, 0], ["kworker\/0:0H", "root", 0, 0, 0], ["mm_percpu_wq", "root", 0, 0, 0], ["ksoftirqd\/0", "root", 0, 0, 0], ["rcu_sched", "root", 0, 0, 0], ["rcu_bh", "root", 0, 0, 0], ["migration\/0", "root", 0, 0, 0], ["watchdog\/0", "root", 0, 0, 0], ["cpuhp\/0", "root", 0, 0, 0], ["kdevtmpfs", "root", 0, 0, 0], ["netns", "root", 0, 0, 0], ["rcu_tasks_kthre", "root", 0, 0, 0], ["kauditd", "root", 0, 0, 0], ["khungtaskd", "root", 0, 0, 0], ["oom_reaper", "root", 0, 0, 0], ["writeback", "root", 0, 0, 0], ["kcompactd0", "root", 0, 0, 0], ["ksmd", "root", 0, 0, 0], ["khugepaged", "root", 0, 0, 0], ["crypto", "root", 0, 0, 0], ["kintegrityd", "root", 0, 0, 0], ["kblockd", "root", 0, 0, 0], ["ata_sff", "root", 0, 0, 0], ["md", "root", 0, 0, 0], ["edac-poller", "root", 0, 0, 0], ["devfreq_wq", "root", 0, 0, 0], ["watchdogd", "root", 0, 0, 0], ["kswapd0", "root", 0, 0, 0], ["kworker\/u3:0", "root", 0, 0, 0], ["ecryptfs-kthrea", "root", 0, 0, 0], ["kthrotld", "root", 0, 0, 0], ["acpi_thermal_pm", "root", 0, 0, 0], ["scsi_eh_0", "root", 0, 0, 0], ["scsi_tmf_0", "root", 0, 0, 0], ["scsi_eh_1", "root", 0, 0, 0], ["scsi_tmf_1", "root", 0, 0, 0], ["ipv6_addrconf", "root", 0, 0, 0], ["kstrp", "root", 0, 0, 0], ["charger_manager", "root", 0, 0, 0], ["scsi_eh_2", "root", 0, 0, 0], ["scsi_tmf_2", "root", 0, 0, 0], ["raid5wq", "root", 0, 0, 0], ["jbd2\/sda1-8", "root", 0, 0, 0], ["ext4-rsv-conver", "root", 0, 0, 0], ["kworker\/0:1H", "root", 0, 0, 0], ["systemd-journald", "root", 0, 75, 3.86], ["iscsi_eh", "root", 0, 0, 0], ["systemd-udevd", "root", 0, 4, 0.21], ["ib-comp-wq", "root", 0, 0, 0], ["ib-comp-unb-wq", "root", 0, 0, 0], ["ib_mcast", "root", 0, 0, 0], ["ib_nl_sa_wq", "root", 0, 0, 0], ["rdma_cm", "root", 0, 0, 0], ["lvmetad", "root", 0, 1, 0.05], ["systemd-timesyncd", "systemd-timesync", 0, 3, 0.15], ["systemd-networkd", "systemd-network", 0, 5, 0.26], ["systemd-resolved", "systemd-resolve", 0, 5, 0.26], ["networkd-dispat", "root", 0, 13, 0.67], ["rsyslogd", "syslog", 0, 4, 0.21], ["accounts-daemon", "root", 0, 5, 0.26], ["systemd-logind", "root", 0, 5, 0.26], ["atd", "root", 0, 2, 0.1], ["cron", "root", 0, 2, 0.1], ["lxcfs", "root", 0, 3, 0.15], ["memcached", "memcache", 0, 10, 0.51], ["dbus-daemon", "messagebus", 0, 4, 0.21], ["sshd", "root", 0, 6, 0.31], ["agetty", "root", 0, 2, 0.1], ["agetty", "root", 0, 1, 0.05], ["unattended-upgr", "root", 0, 15, 0.77], ["polkitd", "root", 0, 5, 0.26], ["master", "root", 0, 3, 0.15], ["kworker\/0:0", "root", 0, 0, 0], ["pickup", "postfix", 0, 5, 0.26], ["kworker\/0:1", "root", 0, 0, 0], ["kworker\/u2:0", "root", 0, 0, 0], ["kworker\/u2:2", "root", 0, 0, 0], ["kworker\/u2:1", "root", 0, 0, 0], ["python", "root", 0, 23, 1.18], ["xfsalloc", "root", 0, 0, 0], ["xfs_mru_cache", "root", 0, 0, 0] ], "threshold_avg": "5", "threshold_cpu": "90", "threshold_ram": "80", "threshold_storage": null, "threshold_ping": "10", "threshold_disk": "80", "alert_contacts": ["5ccxxxxxxxxxxxxxxxxxxxxx"], "alert_doublecheck": true } }

PUT/v1/server/{id}/enable

Active ou désactive la surveillance d'un serveur.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=false"

Exemple de réponse

{ "error": 0, "status": false, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/server/{id}

Supprime le serveur surveillé et toutes les informations liées à ce serveur.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error":0 }

POST/v1/server/reports

Retourne une liste des rapports envoyées pour un serveur suivant un intervalle de temps.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément.

Obligatoire :Oui

Valeur par défaut :-

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :200

time_begin

Type :Entier

Description :

Date de début de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :yesterday midnight

time_end

Type :Entier

Description :

Date de fin de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :today midnight

fullcontent

Type :Booléen

Description :

Paramètre permettant de retourner toutes les informations (true) ou limiter à l'essentiel (false).

Obligatoire :Non

Valeur par défaut :false

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/reports -d "id=5ccxxxxxxxxxxxxxxxxxxxxx&time_begin=1585612800&time_end=1585699199"

Exemple de réponse

{ "error": 0, "time_begin": 1585612800, "time_end": 1585695600, "days": 0.999988425925926, "preset": "hourly", "reports": { "data": { "count": 1, "success": 200, "error": 0 }, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "server_status": 0, "time_create": 1585781737, "time_day": 1585699200, "status": 200, "report": "{\"uptime\":2753446,\"load_average\":0.3,\"cpu_usage\":5.01,\"ram_usage\":36.92,\"swap_usage\":0,\"storage_usage\":42.11,\"remote_addr\":\"xxx.xxx.xxx.xxx\",\"system_os\":\"linux\"}", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, } } }

GET/v1/server/report/{id}

Retourne les informations spécifiques d'un rapport envoyé par le serveur.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/report/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "time": 1588290953, "report_status": 200, "report": "{\"uptime\":5262645,\"load_average\":0.01,\"cpu_usage\":6.59,\"ram_usage\":39.02,\"swap_usage\":0,\"storage_usage\":42.11,\"remote_addr\":\"xxx.xxx.xxx.xxx\",\"system_os\":\"linux\"}", "server_status": 0, "json": "{\"load_average\":[0.01,0.03,0],\"uptime\":5262645,\"operating_system\":\"Linux\",\"swap\":{\"available\":0,\"total\":0,\"used\":0},\"memory\":{\"available\":1186,\"total\":1945,\"used\":499},\"process\":[[\"systemd\",\"root\",0,9],[\"kthreadd\",\"root\",0,0],[\"kworker\\\/0:0H\",\"root\",0,0],[\"mm_percpu_wq\",\"root\",0,0],[\"ksoftirqd\\\/0\",\"root\",0,0],[\"rcu_sched\",\"root\",0,0],[\"rcu_bh\",\"root\",0,0],[\"migration\\\/0\",\"root\",0,0],[\"watchdog\\\/0\",\"root\",0,0],[\"cpuhp\\\/0\",\"root\",0,0],[\"kdevtmpfs\",\"root\",0,0],[\"netns\",\"root\",0,0],[\"rcu_tasks_kthre\",\"root\",0,0],[\"kauditd\",\"root\",0,0],[\"khungtaskd\",\"root\",0,0],[\"oom_reaper\",\"root\",0,0],[\"writeback\",\"root\",0,0],[\"kcompactd0\",\"root\",0,0],[\"ksmd\",\"root\",0,0],[\"khugepaged\",\"root\",0,0],[\"crypto\",\"root\",0,0],[\"kintegrityd\",\"root\",0,0],[\"kblockd\",\"root\",0,0],[\"ata_sff\",\"root\",0,0],[\"md\",\"root\",0,0],[\"edac-poller\",\"root\",0,0],[\"devfreq_wq\",\"root\",0,0],[\"watchdogd\",\"root\",0,0],[\"kswapd0\",\"root\",0,0],[\"kworker\\\/u3:0\",\"root\",0,0],[\"ecryptfs-kthrea\",\"root\",0,0],[\"kthrotld\",\"root\",0,0],[\"acpi_thermal_pm\",\"root\",0,0],[\"scsi_eh_0\",\"root\",0,0],[\"scsi_tmf_0\",\"root\",0,0],[\"scsi_eh_1\",\"root\",0,0],[\"scsi_tmf_1\",\"root\",0,0],[\"ipv6_addrconf\",\"root\",0,0],[\"kstrp\",\"root\",0,0],[\"charger_manager\",\"root\",0,0],[\"scsi_eh_2\",\"root\",0,0],[\"scsi_tmf_2\",\"root\",0,0],[\"raid5wq\",\"root\",0,0],[\"jbd2\\\/sda1-8\",\"root\",0,0],[\"ext4-rsv-conver\",\"root\",0,0],[\"kworker\\\/0:1H\",\"root\",0,0],[\"systemd-journald\",\"root\",0,67],[\"iscsi_eh\",\"root\",0,0],[\"systemd-udevd\",\"root\",0,4],[\"ib-comp-wq\",\"root\",0,0],[\"ib-comp-unb-wq\",\"root\",0,0],[\"ib_mcast\",\"root\",0,0],[\"ib_nl_sa_wq\",\"root\",0,0],[\"rdma_cm\",\"root\",0,0],[\"lvmetad\",\"root\",0,1],[\"systemd-timesyncd\",\"systemd-timesync\",0,3],[\"systemd-networkd\",\"systemd-network\",0,5],[\"systemd-resolved\",\"systemd-resolve\",0,5],[\"networkd-dispat\",\"root\",0,13],[\"rsyslogd\",\"syslog\",0,4],[\"accounts-daemon\",\"root\",0,5],[\"systemd-logind\",\"root\",0,5],[\"atd\",\"root\",0,2],[\"cron\",\"root\",0,2],[\"lxcfs\",\"root\",0,3],[\"memcached\",\"memcache\",0,10],[\"dbus-daemon\",\"messagebus\",0,4],[\"sshd\",\"root\",0,6],[\"agetty\",\"root\",0,2],[\"agetty\",\"root\",0,1],[\"unattended-upgr\",\"root\",0,15],[\"polkitd\",\"root\",0,5],[\"master\",\"root\",0,3],[\"qmgr\",\"postfix\",0,4],[\"kworker\\\/0:1\",\"root\",0,0],[\"tlsmgr\",\"postfix\",0,5],[\"pickup\",\"postfix\",0,5],[\"kworker\\\/u2:2\",\"root\",0,0],[\"kworker\\\/u2:0\",\"root\",0,0],[\"kworker\\\/u2:1\",\"root\",0,0],[\"python\",\"root\",0,23],[\"xfsalloc\",\"root\",0,0],[\"xfs_mru_cache\",\"root\",0,0],[\"kworker\\\/0:0\",\"root\",0,0],[\"\\\/usr\\\/sbin\\\/apach\",\"root\",0,39]],\"storage\":[{\"total\":19,\"name\":\"\\\/\",\"used\":8},{\"total\":0,\"name\":\"\\\/boot\\\/efi\",\"used\":0}],\"cpu\":6.590000000000001,\"network\":{\"tx\":0,\"rx\":0},\"remote_addr\":\"xxx.xxx.xxx.xxx\"}", "output": "{\"error\":0,\"msg\":\"OK\"}" }

POST/v1/server/alerts

Retourne une liste des alertes envoyées pour un serveur suivant un intervalle de temps.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément.

Obligatoire :Oui

Valeur par défaut :-

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :200

time_begin

Type :Entier

Description :

Date de début de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :yesterday midnight

time_end

Type :Entier

Description :

Date de fin de l'affichage des données (timestamp unix).

Obligatoire :Non

Valeur par défaut :today midnight

fullcontent

Type :Booléen

Description :

Paramètre permettant de retourner toutes les informations (true) ou limiter à l'essentiel (false).

Obligatoire :Non

Valeur par défaut :false

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/alerts -d "id=5ccxxxxxxxxxxxxxxxxxxxxx&time_begin=1585612800&time_end=1585699199"

Exemple de réponse

{ "error": 0, "time_begin": 1585612800, "time_end": 1588204800, "days": 30, "preset": "daily", "alerts": { "count": 6, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "slack", "time_create": 1586869535, "server_status": "0", "url": "https:\/\/hooks.slack.com\/services\/XXXXXXXXX\/XXXXXXXXX\/XXXXXXXXXXXXXXXXXXXXXXXXX", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "email", "time_create": 1586869535, "server_status": "0", "to": "alert@hitflow.net", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "telegram", "time_create": 1586869535, "server_status": "0", "to": "XXXXXXXX \/\/ @xxxxxxx [999999999]", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "email", "time_create": 1586869220, "server_status": "106", "to": "alert@hitflow.net", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "telegram", "time_create": 1586869220, "server_status": "106", "to": "XXXXXXXX \/\/ @xxxxxxx [999999999]", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": "slack", "time_create": 1586869219, "server_status": "106", "url": "https:\/\/hooks.slack.com\/services\/XXXXXXXXX\/XXXXXXXXX\/XXXXXXXXXXXXXXXXXXXXXXXXX", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" } } } }

GET/v1/server/alert/{id}

Retourne les informations spécifiques d'une alerte envoyée pour un serveur.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/server/alert/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "time": 1586869535, "type": "email", "server_status": "0", "content": { "object": "[Hitflow.fr] Le serveur \"Hitflow Website\" est de nouveau op\u00e9rationnel", "html": "<html>\n<head>\n<meta charset=\"utf-8\">\n\n<style type=\"text\/css\">\nbody\n{\n\tpadding:0;\n\tmargin:0;\n\tcolor:#1d223d;\n\tbackground:#fff;\n}\n.header\n{\n\tmargin:0;\n\tpadding:10px 20px;\n\tcolor:#fff;\n\tbackground:#29292A;\n}\n.content\n{\n\tmargin:0;\n\tpadding:10px;\n}\n<\/style>\n<\/head>\n<body style=\"margin:0;padding:0;color:#1d223d;\" bgcolor=\"#fff\">\n\t<div class=\"header\" style=\"margin:0;padding:10px 20px;color:#fff;background:#29292A;\" bgcolor=\"#29292A\">Hitflow<\/div>\n\t<div class=\"content\" style=\"margin:0;padding:10px;color:#1d223d;\" bgcolor=\"#fff\">\n\t\t<p>Bonjour,<\/p>\n<p>Le serveur <strong>Hitflow Website<\/strong> (linux \/ xxx.xxx.xxx.xxx) est de nouveau op\u00e9rationnel.<\/p>\n<p>La perturbation constat\u00e9e sur le serveur a dur\u00e9e 5 minutes 16 secondes.<\/p>\n<p>Cordialement<\/p>\n<p>\n Hitflow<br \/>\n <a href=\"https:\/\/hitflow.net\" title=\"\">https:\/\/hitflow.net<\/a><br \/>\n <a href=\"https:\/\/twitter.com\/HitflowFR\" title=\"\">https:\/\/twitter.com\/HitflowFR<\/a>\n<\/p>\n\t<\/div>\n<\/body>\n<\/html>", "text": "Hitflow\n\nBonjour,\n\nLe serveur Hitflow Website (linux \/ xxx.xxx.xxx.xxx) est de nouveau op\u00e9rationnel.\n\nLa perturbation constat\u00e9e sur le serveur a dur\u00e9e 5 minutes 16 secondes.\n\nCordialement\nHitflow\nhttps:\/\/hitflow.net\nhttps:\/\/twitter.com\/HitflowFR" }, "to": "alert@hitflow.net" }

Certificats SSL

POST/v1/certificates/search

Retourne la liste des tests de certificats SSL du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

query

Type :Chaîne de caractère

Description :

Chaîne de caractères contenant les termes de recherche à trouver dans la liste.

Obligatoire :Non

Valeur par défaut :-

status

Type :Tableau

Description :

Tableau d'entier permettant de limiter l'affichage des entrées :

  • 1 : le statut est "désactivée"
  • 2 : le statut est "erreur"
  • 3 : le statut est "en ligne"
  • 4 : le statut est "inconnu"

Obligatoire :Non

Valeur par défaut :-

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/certificates/search

Exemple de réponse

{ "error": 0, "count": 2, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow Website", "status": 0, "enable": true, "check_rate": "86400", "response_uptime": null, "url": "https:\/\/hitflow.net", "issuer": "Let's Encrypt Authority X3", "time_valide_from": "1587453091", "time_valide_to": "1595229091", "signatureTypeSN": "RSA-SHA256", "signatureTypeLN": "sha256WithRSAEncryption", "signatureTypeNID": "668", "hash": "1ae313a3", "certname": "\/CN=hitflow.net", "subject": { "CN": "hitflow.net" }, "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow Manager", "status": 0, "enable": true, "check_rate": "86400", "response_uptime": null, "url": "https:\/\/manager.hitflow.net", "issuer": "Let's Encrypt Authority X3", "time_valide_from": "1585087276", "time_valide_to": "1592863276", "signatureTypeSN": "RSA-SHA256", "signatureTypeLN": "sha256WithRSAEncryption", "signatureTypeNID": "668", "hash": "1c64231a", "certname": "\/CN=manager.hitflow.net", "subject": { "CN": "manager.hitflow.net" }, "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 }, } }

GET/v1/certificate/{id}

Retourne les informations relatives au test du certificat SSL.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/certificate/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "time_create": 1574691015, "time_update": 1588435391, "time_enable": 1582732127, "time_disable": 1582513564, "time_down": null, "time_up": 1582732138, "time_delete": null, "time_lastcheck": 1588435391, "time_nextcheck": 1588521791, "time_lastreminder": 1588363806, "time_nextreminder": 1588450206, "name": "Hitflow Manager", "status": 0, "enable": true, "check_rate": "86400", "check_countries": null, "check_timeout": 60, "alert_contacts": ["5ccxxxxxxxxxxxxxxxxxxxxx"], "alert_onbackup": true, "alert_onchange": true, "response_uptime": null, "response_uptime_checkers": null, "response_data": null, "url": "https:\/\/manager.hitflow.net", "reminder_first": "15", "reminder_second": "7", "reminder_final": "3", "issuer": "Let's Encrypt Authority X3", "time_valide_from": "1585087276", "time_valide_to": "1592863276", "signatureTypeSN": "RSA-SHA256", "signatureTypeLN": "sha256WithRSAEncryption", "signatureTypeNID": "668", "hash": "1c64231a", "certname": "\/CN=manager.hitflow.net", "subject": { "CN": "manager.hitflow.net" } } }

PUT/v1/certificate/{id}/enable

Active ou désactive la surveillance d'un certificat SSL.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/certificate/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=false"

Exemple de réponse

{ "error": 0, "status": false, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/certificate/{id}

Supprime le test de certificat SSL et les informations liées à ce test.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/certificate/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0 }

POST/v1/certificate/{id}/interval

Change l'intervalle de contrôle pour le test du certificat SSL.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

interval

Type :Entier

Description :

L'intervalle doit être une des valeurs suivantes : 86400, 172800, 604800, 1296000.

Obligatoire :Non

Valeur par défaut :604800

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/certificate/5ccxxxxxxxxxxxxxxxxxxxxx/interval -d "interval=86400"

Exemple de réponse

{ "error": 0, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

Noms de domaines

POST/v1/domains/search

Retourne la liste des noms de domaines à surveiller du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

query

Type :Chaîne de caractère

Description :

Chaîne de caractères contenant les termes de recherche à trouver dans la liste.

Obligatoire :Non

Valeur par défaut :-

status

Type :Tableau

Description :

Tableau d'entier permettant de limiter l'affichage des entrées :

  • 1 : le statut est "désactivée"
  • 2 : le statut est "erreur"
  • 3 : le statut est "en ligne"
  • 4 : le statut est "inconnu"

Obligatoire :Non

Valeur par défaut :-

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/domains/search

Exemple de réponse

{ "error": 0, "count": 2, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow NET", "status": 0, "enable": true, "check_rate": 86400, "domain_name": "hitflow.net", "registrar": "OVH sas", "owner": null, "time_valide_from": "1572566400", "time_valide_to": "1604249684", "state": "clientDeleteProhibited clientTransferProhibited", "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 2 }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "name": "Hitflow FR", "status": 0, "enable": true, "check_rate": 86400, "domain_name": "hitflow.fr", "registrar": "AFNIC", "owner": { "type": "PERSON", "contact": "Ano Nymous" }, "time_valide_from": "1508889600", "time_valide_to": "1603612087", "state": "ACTIVE", "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "count_contacts": 1 } } }

GET/v1/domain/{id}

Retourne les informations relatives au test du nom de domaine.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/domain/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "time_create": 1574592912, "time_update": 1588367407, "time_enable": 1582732132, "time_disable": 1582513564, "time_down": 1580748624, "time_up": 1588367406, "time_delete": null, "time_lastcheck": 1588367406, "time_nextcheck": null, "time_lastreminder": 1588367406, "time_nextreminder": 1588453806, "name": "Hitflow NET", "status": 0, "enable": true, "check_rate": 86400, "alert_contacts": [ "5ccxxxxxxxxxxxxxxxxxxxxx", "5ccxxxxxxxxxxxxxxxxxxxxx" ], "alert_onbackup": true, "alert_onchange": true, "domain_name": "hitflow.net", "reminder_first": "30", "reminder_second": "7", "reminder_final": "3", "registrar": "OVH sas", "owner": null, "time_valide_from": "1572566400", "time_valide_to": "1604249684", "state": "clientDeleteProhibited clientTransferProhibited" } }

PUT/v1/domain/{id}/enable

Active ou désactive la surveillance d'un nom de domaine.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/domain/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=false"

Exemple de réponse

{ "error": 0, "status": false, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/domain/{id}

Change l'intervalle de contrôle pour le test du nom de domaine.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/domain/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error":0 }

Contacts

POST/v1/contacts/search

Retourne la liste des contacts du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/contacts/search

Exemple de réponse

{ "error": 0, "count": 1, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "type": null, "locale": "en_US.utf8", "enable": false, "list": [{ "type": "email", "email": "hello@hitflow.net" }], "telegram_counter": 1, "name": "Default Contact", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, ... } }

GET/v1/contact/{id}

Retourne les informations relatives à un contact.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/contact/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "type": null, "locale": "en_US.utf8", "timezone": "Europe\/Paris", "enable": false, "time_create": 1565713630, "time_update": 1578068747, "time_delete": null, "list": [{ "type": "email", "email": "hello@hitflow.net" }, { "type": "telegram", "linked": "false", "code": 00000000, "chat_id": null, "firstname": null, "username": null, "lastname": null }], "telegram_counter": 1, "email_format": "html", "hours_allowed": [ [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1], [1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1] ], "name": "Default contact", "uptimes": [{ "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "type": "icmp", "enable": true, "name": "Uptime Test", "host": "xxx.xxx.xxx.xxx", "port": null, "linked": false }, ... ], "certificates": [{ "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "enable": true, "name": "Certificat Test", "url": "https:\/\/hitflow.net", "linked": false }, ... ], "domains": [{ "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "enable": true, "name": "Domain Test", "domain_name": "hitflow.net", "linked": false }, ... ], "servers": [{ "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "enable": true, "name": "Server Test", "remote_addr": "xxx.xxx.xxx.xxx", "linked": false }, ... ] } }

PUT/v1/contact/{id}/enable

Activer ou désactiver les alertes pour le contact.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/contact/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=true"

Exemple de réponse

{ "error": 0, "status": true, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/contact/{id}

Supprimer le contact du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/contact/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error":0 }

Pages de statut public

POST/v1/statuspages/search

Retourne la liste des pages de statut public du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/statuspages/search

Exemple de réponse

{ "error": 0, "count": 2, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "title": "status.hitflow.fr", "enable": true, "password": null, "uri_uid": "xxxxxxxxxxxxx", "uri_hostname": "status.hitflow.fr", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }, "5ccxxxxxxxxxxxxxxxxxxxxx": { "title": "status.hitflow.net", "enable": true, "password": null, "uri_uid": "xxxxxxxxxxxxx", "uri_hostname": "status.hitflow.net", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" } } }

GET/v1/statuspage/{id}

Retourne les informations relatives à la page de statut public.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/statuspage/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "time_create": 1574672721, "time_update": 1582732170, "time_delete": null, "time_disable": null, "title": "status.hitflow.net", "title_public": "Status of Hitflow.net services during the last 90 days....", "enable": true, "logo_url": null, "password": null, "uri_uid": "xxxxxxxxxxxxx", "uri_hostname": "status.hitflow.net", "uri_protocol": "http", "hits": [ "5ccxxxxxxxxxxxxxxxxxxxxx", "5ccxxxxxxxxxxxxxxxxxxxxx", "5ccxxxxxxxxxxxxxxxxxxxxx", "5ccxxxxxxxxxxxxxxxxxxxxx", "5ccxxxxxxxxxxxxxxxxxxxxx" ], "style_css": null, "auto_refresh": "0", "tracker_ga": "UA-xxxxxxxxx-x" } }

PUT/v1/statuspage/{id}/enable

Active ou désactive l'accès à la page de statut public.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/statuspage/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=true"

Exemple de réponse

{ "error": 0, "status": true, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/statuspage/{id}

Supprime la page de statut public et toutes les informations liées à cette page.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/statuspage/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0 }

Maintenances

POST/v1/maintenances/search

Retourne la liste des maintenances du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/maintenances/search

Exemple de réponse

{ "error": 0, "count": 1, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "time_begin": 1588586400, "time_end": 1588975140, "name": "Test Hitflow", "type": "weekly", "id": "5ccxxxxxxxxxxxxxxxxxxxxx" } } }

GET/v1/maintenance/{id}

Retourne les informations relatives à une maintenance.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/maintenance/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "data": { "id": "5ccxxxxxxxxxxxxxxxxxxxxx", "version": 1, "account_id": "5ccxxxxxxxxxxxxxxxxxxxxx", "time_create": 1588411736, "time_update": 1588411736, "time_delete": null, "time_begin": 1588586400, "time_end": 1588975140, "name": "Test Hitflow", "type": "weekly", "auto_toggle": true, "uptimes": [ "5ccxxxxxxxxxxxxxxxxxxxxx", ], "servers": null, "repeat_done": false, "toggle_off_done": false, "toggle_on_done": false } }

DELETE/v1/maintenance/{id}

Supprime une maintenance du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/maintenance/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0 }

Intégrations

POST/v1/integrations/search

Retourne la liste des intégrations du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

index

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :0

limit

Type :Entier

Description :

Valeur allant de 0 à 1000.

Obligatoire :Non

Valeur par défaut :50

query

Type :Chaîne de caractère

Description :

Chaîne de caractères contenant les termes de recherche à trouver dans la liste.

Obligatoire :Non

Valeur par défaut :-

types

Type :Tableau

Description :

Tableau contenant les types d'entrées à afficher dans la liste.
Les valeurs possibles sont : slack, zapier

Obligatoire :Non

Valeur par défaut :-

Exemple cURL

curl -XPOST -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access:xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/integrations/search

Exemple de réponse

{ "error":0, "count":1, "list": { "5ccxxxxxxxxxxxxxxxxxxxxx": { "type":"slack", "time_create":1592383925, "name":"Hitflow", "enable":true, "data": { "team_name":"Hitflow", "channel":"#hitflow-monitoring" }, "id":"5ccxxxxxxxxxxxxxxxxxxxxx" } } }

GET/v1/integration/{id}

Retourne les informations relatives à une intégration.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XGET -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/integration/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error":0, "data": { "type":"slack", "time_create":1592383925, "time_update":1592389254, "time_enable":1592389241, "time_disable":null, "name":"Hitflow", "enable":true, "data": { "team_name":"Hitflow", "channel":"#hitflow-monitoring" }, "id":"5ccxxxxxxxxxxxxxxxxxxxxx" } }

PUT/v1/integration/{id}/enable

Active ou désactive les alertes relatives à une integration.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

enable

Type :Booléen

Description :

Paramètre permettant l'activation (true) ou la désactivation (false).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/integration/5ccxxxxxxxxxxxxxxxxxxxxx/enable -d "enable=true"

Exemple de réponse

{ "error": 0, "status": true, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }

DELETE/v1/integration/{id}

Supprime une intégration du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XDELETE -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/integration/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0 }

PUT/v1/integration/{id}

Renommer une intégration du compte.

Entêtes

  • HitFlow-Token-Access : Token de session
  • HitFlow-Account-Selected : Identifiant unique du compte

Paramètres

Nom

Type

Description

Obligatoire

Valeur par défaut

id

Type :Chaîne de caractère

Description :

Identifiant unique de l'élément (dans l'URL).

Obligatoire :Oui

Valeur par défaut :-

name

Type :Chaîne de caractère

Description :

Chaîne de caractère contenant le nom de l'entrée

Obligatoire :Oui

Valeur par défaut :-

Exemple cURL

curl -XPUT -H "Content-type: application/x-www-form-urlencoded" -H "HitFlow-Token-Access: xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx" -H "HitFlow-Account-Selected: 5ccxxxxxxxxxxxxxxxxxxxxx" https://wapi.hitflow.net/v1/integration/5ccxxxxxxxxxxxxxxxxxxxxx

Exemple de réponse

{ "error": 0, "id": "5ccxxxxxxxxxxxxxxxxxxxxx" }