Consulter un serveur

GET /api/servers/(string: server_name)

Renvoie les informations du serveur portant le nom server_name.

En-têtes de requête:
Status Codes:
  • 200 OK – Les informations du serveur ont été renvoyées avec succès

  • 401 Unauthorized – Authentification d’utilisateur invalide

  • 404 Not Found – Le serveur demandé n’existe pas

Objet 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])

  • enabled (bool) – Indique si le serveur est activé ou non au démarrage de la gateway.

  • root (string) – La racine du serveur. Peut être relatif (à la racine de la gateway) 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. (OBSOLÈTE: remplacé par “receiveDir”)

  • outDir (string) – Le dossier d’envoi du serveur. Peut être relatif (à la racine du serveur) ou absolu. (OBSOLÈTE: remplacé par “sendDir”)

  • workDir (string) – Le dossier temporaire du serveur. Peut être relatif (à la racine du serveur) ou absolu. (OBSOLÈTE: remplacé par “tmpReceiveDir”)

  • rootDir (string) – Chemin du dossier racine du serveur. Peut être relatif (à la racine de la 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.

  • 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_gateway.net/api/servers/sftp_server HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "name": "sftp_server",
  "protocol": "sftp",
  "address": "localhost:2022",
  "rootDir": "/sftp/root",
  "receiveDir: "in",
  "sendDir": "out",
  "tmpReceiveDir": "tmp",
  "protoConfig": {},
  "authorizedRules": {
    "sending": ["règle_envoi_1", "règle_envoi_2"],
    "reception": ["règle_récep_1", "règle_récep_2"]
  }
}