Remplacer un serveur

PUT /api/servers/(string: server_name)

Remplace le serveur demandé par celui renseigné en JSON.

Avertissement

Les dossiers d’envoi, de réception et de travail devant rester distincts, une valeur par défaut leur sera attribuée si l’utilisateur renseigne une racine (root) sans donner de valeur aux sous-dossiers.

En-têtes de requête:
Objet JSON de requête:
  • name (string) – Le nom du serveur

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

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

  • root (string) – La racine du serveur. Peut être relatif (à la racine de la gateway) ou absolu (OBSOLÈTE: remplacé par “rootDir”).

  • inDir (string) – Le dossier de réception du serveur. Peut être relatif (à la racine du serveur) ou absolu. (OBSOLÈTE: remplacé par “receiveDir”)

  • outDir (string) – Le dossier d’envoi du serveur. Peut être relatif (à la racine du serveur) ou absolu. (OBSOLÈTE: remplacé par “sendDir”)

  • workDir (string) – Le dossier temporaire du serveur. Peut être relatif (à la racine du serveur) ou absolu. (OBSOLÈTE: remplacé par “tmpReceiveDir”)

  • rootDir (string) – Chemin du dossier racine du serveur. Peut être relatif (à la racine de la gateway) ou absolu.

  • receiveDir (string) – Le dossier de réception du serveur. Peut être relatif (à la racine du serveur) ou absolu.

  • sendDir (string) – Le dossier d’envoi du serveur. Peut être relatif (à la racine du serveur) ou absolu.

  • tmpReceiveDir (string) – Le dossier temporaire du serveur. Peut être relatif (à la racine du serveur) ou absolu.

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

Status Codes:
En-têtes de réponse:
  • Location – Le chemin d’accès au serveur modifié


Exemple de requête

PUT https://my_waarp_gateway.net/api/servers/sftp_server HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 148

{
  "name": "sftp_server_new",
  "protocol": "sftp",
  "address": "localhost:2023",
  "root": "/new/sftp/root",
  "protoConfig": {}
}

Exemple de requête

HTTP/1.1 201 CREATED
Location: https://my_waarp_gateway.net/api/servers/sftp_server_new