Lister les clients

GET /api/clients/(string: client_name)

Renvoie une liste des clients remplissant les critères donnés en paramètres de requête.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Paramètres:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort (string) – Le paramètre selon lequel les partenaires seront triés Valeurs possibles : name+, name-, protocol+, protocol-. (défaut: name+)

Status Codes:

• 200 OK – La liste a été renvoyée avec succès

• 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

Objet JSON de réponse:

• clients (array) – La liste des clients demandés.

Tableau d’objets JSON de réponse:

• name (string) – Le nom du client.

• localAddress (string) – L’adresse locale du client (en format [adresse:port])

• protoConfig (object) – La configuration du client encodé sous forme d’un objet JSON. Cet objet dépend du protocole.

• partners (array) –

  La liste des partenaires rattachés au client. Voir Lister les partenaires pour plus de détails sur la structure de cette liste.

  • sending (array of string) - Les règles d’envoi.

  • reception (array of string) - Les règles de réception.

Exemple de requête

GET https://my_waarp_gateway.net/api/clients?limit=10&sort=name- HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "clients": [{
    "name": "sftp_client",
    "localAddress": "0.0.0.0:2222",
    "protoConfig": {},
    "partners": []
  },{
    "name": "r66_client",
    "localAddress": "0.0.0.0:6666",
    "protoConfig": {},
    "partners": []
  }]
}