Objectif
Cet appel permet de recevoir la liste des uuids et des noms de tous les hôtes ainsi que de leurs checks.
Paramètres
| Nom du paramètre | Retour | Exemple |
|---|---|---|
| hostgroup_name ( optionnel ) | Liste des hôtes ayant pour nom de groupe la valeur exacte du paramètre hostgroup_name. Plusieurs valeurs peuvent être spécifiées grâce au séparateur "^^". Si plusieurs valeurs sont précisées, retourne les hôtes de chaque |
groupe. | hostgroup_name=gironde^^aveyron |
| Warning | ||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Les valeurs de ce paramètre sont utilisées dans une URL. Ainsi leur contenu doit être échappé (URL encodée) s'ils contiennent des caractères interdits dans une URL :
Exemple: hostgroup_name=mon (groupe) doit s'écrire hostgroup_name=mon+%28groupe%29 Pour plus d'information, vous pouvez consulter : https://developer.mozilla.org/fr/docs/Glossary/percent-encoding et rfc3986 |
Réponse
Codes de retour
| Codes de retour | Explications |
|---|---|
| 200 | OK |
| 401 | Permission refusée (Mauvais token) |
Retour du code 200
- hosts :
- host_uuid : text
- host_name : text
- checks :
- check_uuid : text
Exemple
Appel simple à la route http://localhost:50100/api/v1/host
| Code Block | ||
|---|---|---|
| ||
{
"hosts":[
{
"host_uuid":"ac169cd1fb5744999eaadc5da595f88b",
"host_name":"Bordeaux",
"checks":[
]
},
{
"host_uuid":"0dcad2b1667642d28c933de70915331e",
"host_name":"Paris",
"checks":[
"0dcad2b1667642d28c933de70915331e-905374c0f6ed11e78cd83cf862f4613a",
"0dcad2b1667642d28c933de70915331e-714f6a1b90b318bbcfffb1a71d6258af",
"0dcad2b1667642d28c933de70915331e-8537fb11f6ed11e7bf9f3cf862f4613a",
"0dcad2b1667642d28c933de70915331e-8700ea097f3eb219b0e61d871936bfe4"
]
},
{
"host_uuid":"0dcad2b1667642d28c933de70915331f",
"host_name":"Bruges",
"checks":[
"0dcad2b1667642d28c933de70915331f-905374c0f6ed11e78cd83cf862f4613b",
"0dcad2b1667642d28c933de70915331f-714f6a1b90b318bbcfffb1a71d6258ag",
"0dcad2b1667642d28c933de70915331f-8537fb11f6ed11e7bf9f3cf862f4613b",
"0dcad2b1667642d28c933de70915331f-8700ea097f3eb219b0e61d871936bfe5"
]
},
{
"host_uuid":"tv985cd1fb5744999eaadc5da595f88c",
"host_name":"Royan",
"checks":[
]
}
]
}
|
Appel à la route http://localhost:50100/api/v1/host avec un filtre sur le hostgroup_name
| Code Block | ||
|---|---|---|
| ||
{
"hosts":[
{
"host_uuid":"ac169cd1fb5744999eaadc5da595f88b",
"host_name":"Bordeaux",
"checks":[
]
},
{
"host_uuid":"0dcad2b1667642d28c933de70915331f",
"host_name":"Bruges",
"checks":[
"0dcad2b1667642d28c933de70915331f-905374c0f6ed11e78cd83cf862f4613b",
"0dcad2b1667642d28c933de70915331f-714f6a1b90b318bbcfffb1a71d6258ag",
"0dcad2b1667642d28c933de70915331f-8537fb11f6ed11e7bf9f3cf862f4613b",
"0dcad2b1667642d28c933de70915331f-8700ea097f3eb219b0e61d871936bfe5"
]
},
{
"host_uuid":"tv985cd1fb5744999eaadc5da595f88c",
"host_name":"Royan",
"checks":[
]
}
]
}
|