Créer un serveur¶
-
POST
/api/servers
¶ Ajoute un nouveau serveur avec les informations renseignées 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.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é créé avec succès
- 400 Bad Request – Un ou plusieurs des paramètres du serveur sont invalides
- 401 Unauthorized – Authentification d’utilisateur invalide
Response Headers: - Location – Le chemin d’accès au nouveau serveur créé
Exemple de requête
POST https://my_waarp_gateway.net/api/servers HTTP/1.1 Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ== Content-Type: application/json Content-Length: 140 { "name": "sftp_server", "protocol": "sftp", "address": "localhost:2022", "root": "/sftp/root", "protoConfig": {} }
Exemple de réponse
HTTP/1.1 201 CREATED Location: https://my_waarp_gateway.net/api/servers/sftp_server