Sommaire
Les routes ( appels REST )
Les routes suivantes sont mises à disposition par l'API.
- V2 - Les paramètres des API du broker-module-livedata
- V2 - ( READ ) /api/v2/inventory
- V2 - ( READ ) /api/v2/all-monitored-elements
- V2 - ( READ ) /api/v2/hosts
- V2 - ( READ ) /api/v2/host/{ID}
- V2 - ( READ ) /api/v2/clusters
- V2 - ( READ ) /api/v2/cluster/{ID}
- V2 - ( READ ) /api/v2/checks
- V2 - ( READ ) /api/v2/check/{ID}
- V2 - ( READ ) /api/v2/sla -- OPTIONNEL --
- V2 - Les propriétés présentes dans le retour 200 des API du broker-module-livedata
- V2 - Les erreurs communes lors de l'envoi de la requête
Sécurité
L'api est requêtable en HTTP / HTTPS ( via un certificat TLS 1.1/ 1.2 ) en fonction du paramétrage du module ( voir la page Configuration du broker-module-livedata ).
Authentification
Le contrôle d'accès à l'API V2 du module se fait en utilisant le token défini dans le fichier de configuration via le paramètre broker_module_livedata__token pour l'API V1
- Le Token devra être présent dans le header http de la requête :
- { x-api-token : "TOKEN" }
- { x-api-token : "TOKEN" }
- L'ensemble des éléments visibles par cette API est le même que celui de l'administrateur Shinken
- Le mécanisme d'authentification sera modifié dans les prochaines versions
Exemple :
curl -s -S -H 'x-api-token: change_me' -d "output_format=elements_on_same_level" \ http://broker-module-livedata:50100/api/v2/inventory