Créer un serveur

POST /api/servers

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.

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.

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

Exemple de réponse

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