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:

• Authorization – Les identifiants de l’utilisateur

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.

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

Exemple de requête

GET https://my_waarp_gateway.net/api/clients/sftp_client HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "name": "sftp_client",
  "protocol": "sftp",
  "address": "0.0.0.0:2222",
  "protoConfig": {},
  "partners": "partners": [{
    "name": "openssh",
    "address": "10.0.0.1:22",
    "protoConfig": {},
    "authorizedRules": {
      "sending": [],
      "reception": []
    },
    "accounts": [{
      "login": "titi",
      "authorizedRules": {
        "sending": [],
        "reception": []
      }
    }]
  }]
}