> For the complete documentation index, see [llms.txt](https://docs.dydu.ai/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.dydu.ai/developpeurs/reference-api/api-de-statut-du-serveur.md).

# API de statut du serveur

L'API de statut du serveur indique l'état de votre plateforme et de ses applications. Elle est utile pour la surveillance (monitoring).

## Envoyer une requête

* **Adresse** : `https://<serveur>/servlet/api/serverstatus`, en remplaçant `<serveur>` par l'adresse de votre plateforme.
* **Méthode** : `GET`.
* **Authentification** : aucune.

Vous pouvez aussi la tester dans l'interface Swagger : dirigez-vous sur la page **Préférences > Api > Accès aux APIs**, cliquez sur le lien proposé, puis sur **Server status** et sur **GET /serverstatus**.

<table><thead><tr><th width="150">Paramètre</th><th width="100">Obligatoire</th><th>Description</th></tr></thead><tbody><tr><td><code>details</code></td><td>Non</td><td><code>true</code> pour obtenir des informations détaillées sur chaque application.</td></tr><tr><td><code>pretty</code></td><td>Non</td><td><code>true</code> pour obtenir une réponse JSON mise en forme, plus lisible.</td></tr><tr><td><code>httpstatus</code></td><td>Non</td><td><code>true</code> pour que l'API renvoie le code HTTP <strong>503</strong> lorsque le statut du serveur n'est ni « Ok » ni « Warning ». Pratique pour une sonde de surveillance.</td></tr><tr><td><code>callback</code></td><td>Non</td><td>Nom d'une fonction JavaScript, pour recevoir la réponse au format JSONP.</td></tr></tbody></table>

Requête curl :

```
curl -X GET "https://<serveur>/servlet/api/serverstatus?details=true&pretty=true" -H "accept: application/json"
```

Réponse (extrait) :

```
{
  "withDetails": true,
  "volumes": {
    "connectedPeople": 9,
    "connectedOperators": 3,
    "currentDialogs": 273,
    "currentLivechatDialogs": 1
  },
  "applications": {
    "runtime": { "status": "Ok", "durationMs": 40 },
    "dialog": { "status": "Ok", "durationMs": 60 },
    "slogger": { "status": "Ok", "durationMs": 33 },
    "website": { "status": "Ok", "durationMs": 54, "customs": { "sessions": 16 } },
    "servlet": { "status": "Ok", "durationMs": 62, "customs": { "sessions": 0 } },
    "database": { "status": "Ok", "durationMs": 5 },
    "livechat": { "status": "Ok", "durationMs": 11, "customs": { "sessions": 168 } }
  },
  "status": "Ok",
  "hostName": "app1.earth.doyoudreamup.com",
  "date": "2026-11-16 17:40:49",
  "version": "...",
  "durationMs": 61
}
```

Le résultat est mis en cache pendant une seconde.

## Lire la réponse

### Statut du serveur

Le champ **status** donne l'état global du serveur. C'est la valeur à surveiller.

<table><thead><tr><th width="150">Valeur</th><th>Signification</th></tr></thead><tbody><tr><td><code>Ok</code></td><td>Le serveur fonctionne normalement.</td></tr><tr><td><code>Warning</code></td><td>Le serveur fonctionne, mais une application signale un problème.</td></tr><tr><td><code>Error</code></td><td>Le serveur rencontre une erreur.</td></tr><tr><td><code>Unknown</code></td><td>L'état du serveur n'a pas pu être déterminé.</td></tr></tbody></table>

### Volumes

L'objet **volumes** donne l'activité en cours :

* `connectedPeople` : nombre d'utilisateurs du BMS ayant fait une action au cours des 10 dernières minutes ;
* `connectedOperators` : nombre d'opérateurs livechat connectés ;
* `currentDialogs` : nombre de conversations en cours ;
* `currentLivechatDialogs` : nombre de conversations livechat en cours.

La valeur `-1` indique que l'information n'a pas pu être récupérée.

### Applications

L'objet **applications** donne l'état de chaque application du serveur : `runtime`, `dialog`, `slogger`, `website`, `servlet`, `database` et `livechat`. Le champ `status` de chaque application peut valoir :

<table><thead><tr><th width="150">Valeur</th><th>Signification</th></tr></thead><tbody><tr><td><code>Ok</code></td><td>L'application fonctionne normalement.</td></tr><tr><td><code>Warning</code></td><td>L'application signale un problème. Pour <code>servlet</code>, plus de 2 % des requêtes de conversation sont en erreur sur les 5 dernières minutes.</td></tr><tr><td><code>Ko</code></td><td>L'application ne fonctionne pas. Pour <code>servlet</code>, plus de 90 % des requêtes de conversation sont en erreur sur les 5 dernières minutes.</td></tr><tr><td><code>Disabled</code></td><td>L'application est désactivée (par exemple <code>livechat</code> lorsque le livechat n'est pas activé).</td></tr><tr><td><code>NotImplemented</code></td><td>Le contrôle n'est pas disponible pour cette application.</td></tr><tr><td><code>Unknown</code></td><td>L'état de l'application n'a pas pu être déterminé.</td></tr></tbody></table>

{% hint style="info" %}
Les champs `durationMs` indiquent le temps nécessaire pour récupérer chaque information. Ils sont purement informatifs.
{% endhint %}
