Lister les hôtes¶

GET /v2/hosts¶

Renvoie l’ensemble des hôtes conformes aux filtres passés en paramètres de requête, ou simplement le décompte si countOrder=true est passé en paramètre.. Les hôtes peuvent être filtrés par addresse, sur leur utilisation de SSL, ou sur le fait qu’ils soient actifs ou non. Les paramètres offset et limit permettent de fixer un numéro de départ et un nombre maximal d’hôtes désirés, afin de ne renvoyer qu’un sous-ensemble de la liste demandée. Le paramètre order spécifie dans quel ordre les hôtes doivent être ordonées.

Paramètres de requête:

limit (integer) – Fixe le nombre maximal de transferts pouvant être inclus dans la réponse. Utile lorsque le nombre d’entrées sélectionnées par les filtres est trop important pour tenir dans un seule message.
offset (integer) – Indice de la première entrée à inclure dans la réponse. Généralement utilisé en combinaison avec le paramètre limit pour restreindre l’ensemble des hôtes à renvoyer.
order (string) – Spécifie l’attribut à utiliser pour trier les éléments de la réponse, ainsi que le sens du tri. Ce paramètre devrait donc être le nom d’un attribut d’hôte préfixé par « asc » ou « desc », correspondant respectivement à l’ordre croissant et décroissant.
address (string) – Si ce paramètre est défini, la réponse ne contiendra que les hôtes ayant cette adresse.
isSSL (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que les hôtes autorisant les transferts SSL. Et si le paramètre est faux, que ceux ne les autorisant pas. Si le paramètre n’est pas défini, aucun filtrage ne sera fait.
isActive (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que les hôtes actifs. Et si le paramètre est faux, que ceux inactifs. Si le paramètre n’est pas défini, aucun filtrage ne sera fait.
countOrder (boolean) – Si ce paramètre est vrai, la réponse ne contiendra que le nombre des hôtes selon les conditions, sinon la liste réelle. Si le paramètre n’est pas défini, la liste est retournée.

Example request:

GET /v2/hosts HTTP/1.1
Host: example.com

Status Codes:

200 OK –

La requête s’est déroulée avec succès.

Example response:

HTTP/1.1 200 OK
Content-Type: application/json

{
    "totalResults": 1,
    "results": [
        {
            "name": "string",
            "address": "string",
            "port": 1,
            "password": "string",
            "isSSL": true,
            "isAdmin": true,
            "isClient": true,
            "isActive": true,
            "isProxy": true
        }
    ]
}

400 Bad Request –

La requête est invalide, soit à cause de paramètres de requête erronés, soit à cause d’un corps de requête invalide.

Les causes de l’échec de la requête sont données dans le corps de la réponse sour forme d’un tableau JSON.

Example response:

HTTP/1.1 400 Bad Request
Content-Type: application/json

{
    "errors": [
        {
            "message": "Query parameter 'startTrans' : illegal value 'not_a_date'.",
            "errorCode": 4
        },
        {
            "message": "Query parameter 'status' : illegal value 'not_a_status'.",
            "errorCode": 4
        }
    ]
}

415 Unsupported Media Type – Le type de contenu de la requête n’est pas valide pour cette requête.