Créer un serveur

POST /api/servers

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

Obsolète depuis la version 0.2.0: La propriété inDir de la requête a été remplacée par la propriété receiveDir.

Obsolète depuis la version 0.2.0: La propriété outDir de la requête a été remplacée par la propriété sendDir.

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:

• 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) – La racine du serveur. Peut être relatif (à la racine de transfer) 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. (déprécié)

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

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

• rootDir (string) – Chemin du dossier racine du serveur. Peut être relatif (à la racine de transfer) 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é créé avec succès

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

• 401 Unauthorized – Authentification d’utilisateur invalide

En-têtes de réponse:

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

Exemple de requête

POST https://my_waarp_transfer.net/api/servers HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==
Content-Type: application/json
Content-Length: 140

{
  "name": "r66_server",
  "protocol": "r66",
  "address": "localhost:2022",
  "rootDir": "/r66/root",
  "protoConfig": {}
}

Exemple de réponse

HTTP/1.1 201 CREATED
Location: https://my_waarp_transfer.net/api/servers/r66