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:
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.

  • nbOfAttempts (number) – Le nombre de fois qu’un transfert effectué avec ce client sera retenté automatiquement en cas d’échec.

  • firstRetryDelay (number) – Le délai (en secondes) entre la tentative originale d’un transfert et la première reprise automatique.

  • retryIncrementFactor (number) – Le facteur par lequel le délai ci-dessus est multiplié à chaque nouvelle tentative d’un transfert donné.

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.


Exemple de requête

GET https://my_waarp_transfer.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": "r66_client",
    "localAddress": "0.0.0.0:6666",
    "protoConfig": {},
    "nbOfAttempts": 5,
    "firstRetryDelay": 90,
    "retryIncrementFactor": 1.5
  },{
    "name": "r66-tls_client",
    "localAddress": "0.0.0.0:6667",
    "protoConfig": {},
    "nbOfAttempts": 3,
    "firstRetryDelay": 60,
    "retryIncrementFactor": 2
  }]
}