Consulter un client

GET /api/clients/(string: client_name)

Renvoie les informations du client portant le nom client_name.

En-têtes de requête:
Status Codes:

  • 200 OK – Les informations du client ont été renvoyées avec succès

  • 401 Unauthorized – Authentification d’utilisateur invalide

  • 404 Not Found – Le client demandé n’existe pas

Objet JSON de réponse:

  • name (string) – Le nom du client.

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

  • protocol (string) – Le protocole utilisé par le client.

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

  • 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é.

Exemple de requête

GET https://my_waarp_transfer.net/api/clients/r66 HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "name": "r66_client",
  "protocol": "r66",
  "address": "0.0.0.0:2222",
  "protoConfig": {},
  "nbOfAttempts": 5,
  "firstRetryDelay": 90,
  "retryIncrementFactor": 1.5
}