Créer un client

POST /api/clients/(string: client_name)

Ajoute un nouveau client avec les informations renseignées en JSON.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Objet JSON de requête:

• name (string) – Le nom du client.

• protocole (string) – Le protocole du client.

• address (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é créé avec succès.

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

• 401 Unauthorized – Authentification d’utilisateur invalide.

En-têtes de réponse:

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

Exemple de requête

POST https://my_waarp_gateway.net/api/clients/ HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 176

{
  "name": "sftp_client",
  "protocol": "sftp",
  "address": "0.0.0.0:2222",
  "protoConfig": {}
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_gateway.net/api/clients/sftp_client