Modifier un client

PATCH /api/clients/(string: client_name)

Met à jour le client demandé avec les informations renseignées en JSON. Les champs non-spécifiés resteront inchangés.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Objet JSON de requête:

• name (string) – Le nom du client.

• protocol (string) – Le protocole 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.

Status Codes:

• 201 Created – Le client a été modifié avec succès

• 400 Bad Request – Un ou plusieurs des paramètres du client sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

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

En-têtes de réponse:

• Location – Le chemin d’accès au client modifié.

Exemple de requête

PATCH https://my_waarp_transfer.net/api/clients/r66 HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 148

{
  "name": "new_r66_client",
  "protocol": "r66",
  "localAddress": "0.0.0.0:2223",
  "protoConfig": {}
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_transfer.net/api/clients/new_r66_client