Modifier un serveur

PATCH /api/servers/(string: server_name)

Obsolète depuis la version 0.5.0: Les propriétés indir et outDir` de la requête ont été remplacées par les propriétés sendDir et receiveDir.

Obsolète depuis la version 0.5.0: La propriété root``de la requête a été remplacée par la propriété ``rootDir.

Obsolète depuis la version 0.5.0: La propriété workDir` de la requête a été remplacée par la propriété ``tmpReceiveDir.

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

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:

• Authorization – Les identifiants de l’utilisateur

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) – Déprécié. La racine du serveur. Peut être relatif (à la racine de la gateway) ou absolu .

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

• outDir (string) – Déprécié. Le dossier d’envoi du serveur. Peut être relatif (à la racine du serveur) ou absolu.

• workDir (string) – Déprécié. Le dossier temporaire du serveur. Peut être relatif (à la racine du serveur) ou absolu.

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

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

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

• 401 Unauthorized – Authentification d’utilisateur invalide

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

En-têtes de réponse:

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

Exemple de requête

PATCH 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",
  "rootDir": "/new/sftp/root",
  "protoConfig": {}
}

Exemple de requête

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