Statut de Gateway¶

GET /api/about¶

Renvoie les informations sur l’instance Gateway et sur le statut de ses services internes.

En-têtes de requête:

Authorization – Les identifiants de l’utilisateur

Status Codes:

200 OK – Le service est actif
401 Unauthorized – Authentification d’utilisateur invalide

En-têtes de réponse:

Server – La version de l’instance Gateway.
Date – L’heure UTC actuelle en format HTTP-Date standard.
Waarp-Gateway-Date – L’heure locale de Gateway en format RFC 1123.

Objet JSON de réponse:

coreServices (array) –
La liste des services de base de Gateway.
- name (string) - Le nom du service.
- state (string) - L’état du service.
- reason (string) - En cas d’erreur, donne la cause de l’erreur.
servers (object) –
La liste des serveurs de transfert de Gateway.
- name (string) - Le nom du serveur.
- state (string) - L’état du serveur
- reason (string) - En cas d’erreur, donne la cause de l’erreur.
clients (object) –
La liste des clients de transfert de Gateway.
- name (string) - Le nom du client.
- state (string) - L’état du client
- reason (string) - En cas d’erreur, donne la cause de l’erreur.

Exemple de requête

GET https://my_waarp_gateway.net/api/status HTTP/1.1
Authorization: Basic QWxhZGRpbjpvcGVuIHNlc2FtZQ==

Exemple de réponse

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

{
  "coreServices": [
      {
          "name": "Admin",
          "state": "Running",
          "reason": ""
      }, {
          "name": "Database",
          "state": "Error",
          "reason": "Exemple de message d'erreur"
      }, {
          "name": "Controller",
          "state": "Offline",
          "reason": ""
      }
  ],
  "servers": [
      {
          "name": "serveur_sftp",
          "state": "Running",
          "reason": ""
      }, {
          "name": "serveur_r66",
          "state": "Offline",
          "reason": ""
      }
  ],
  "clients": [
      {
          "name": "client_sftp",
          "state": "Error",
          "reason": "Autre exemple de message d'erreur"
      }, {
          "name": "client_r66",
          "state": "Running",
          "reason": ""
      }
  ]
}