Modifier un serveur¶
-
PATCH
/api/servers/
(string: server_name)¶ 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.Request Headers: - Authorization – Les identifiants de l’utilisateur
Request JSON Object: - 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.
- inDir (string) – Le dossier de réception du serveur. Peut être relatif (à la racine du serveur) ou absolu.
- outDir (string) – Le dossier d’envoi du serveur. Peut être relatif (à la racine du serveur) ou absolu.
- workDir (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
Response Headers: - 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", "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