Modifier un partenaire

PATCH /api/partners/(string: partner_name)

Met à jour le partenaire 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 partenaire

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

• address (string) – L’adresse du partenaire (en format [adresse:port])

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

Status Codes:

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

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

• 401 Unauthorized – Authentification d’utilisateur invalide

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

En-têtes de réponse:

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

Exemple de requête

PATCH https://my_waarp_gateway.net/api/partners/waarp_sftp HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 148

{
  "name": "waarp_sftp_new",
  "protocol": "sftp",
  "address": "waarp.org:2023",
  "protoConfig": {}
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_gateway.net/api/partners/waarp_sftp_new