Lister les serveurs

GET /api/servers

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

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

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

Renvoie une liste des serveurs remplissant les critères donnés en paramètres de requête.

En-têtes de requête:

• Authorization – Les identifiants de l’utilisateur

Paramètres:

• limit (int) – Le nombre maximum de résultats souhaités (défaut: 20)

• offset (int) – Le numéro du premier résultat souhaité (défaut: 0)

• sort (string) – Le paramètre selon lequel les serveurs seront triés. Valeurs possibles : name+, name-, protocol+, protocol-. (défaut: name+)

• protocol (string) – Filtre uniquement les serveurs utilisant ce protocole. Peut être renseigné plusieurs fois pour filtrer plusieurs protocoles.

Status Codes:

• 200 OK – La liste a été renvoyée avec succès

• 400 Bad Request – Un ou plusieurs des paramètres de requêtes sont invalides

• 401 Unauthorized – Authentification d’utilisateur invalide

Objet JSON de réponse:

• servers (array) – La liste des serveurs demandés

Tableau d’objets JSON de réponse:

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

• authorizedRules (object) –

  Les règles que le serveur est autorisé à utiliser pour les transferts.

  • sending (array of string) - Les règles d’envoi.

  • reception (array of string) - Les règles de réception.

Exemple de requête

GET https://my_waarp_transfer.net/api/servers?limit=10&sort=name- HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 619

{
  "servers": [{
    "name": "dr66_server_2",
    "protocol": "dr66",
    "address": "localhost:2023",
    "rootDir": "/dr662/root",
    "protoConfig": {},
    "authorizedRules": {
      "sending": ["règle_envoi_1", "règle_envoi_2"],
      "reception": ["règle_récep_1", "règle_récep_2"]
    }
  },{
    "name": "dr66_server_1",
    "protocol": "dr66",
    "address": "localhost:2022",
    "rootDir": "/dr66/root",
    "protoConfig": {},
    "authorizedRules": {
      "sending": ["règle_envoi_1", "règle_envoi_2"],
      "reception": ["règle_récep_1", "règle_récep_2"]
    }
  }]
}