API REST

L’interface de programmation (API) Representational State Transfer (REST) publie des mises à jour de statut et ouvre ou clôture des incidents. Elle ne peut pas lire de données.

Onglet des clés API

Clés API

  • Une clé appartient à un service et ne peut agir que sur ce service.
  • Les membres ADMIN créent et révoquent les clés dans l’onglet Clés API.
  • La clé est affichée une seule fois, juste après sa génération. Seul un hachage est stocké.
  • Les clés n’expirent pas. Révoquez une clé pour qu’elle cesse de fonctionner.

Authentification

Envoyez la clé dans l’un des deux en-têtes :

Authorization: Bearer <key>
X-Api-Key: <key>

Points de terminaison

Méthode et chemin Rôle Succès
POST /api/v1/services/{slug}/status Publier une mise à jour de statut. 201
POST /api/v1/services/{slug}/incidents Ouvrir un incident avec sa première mise à jour. 201
PATCH /api/v1/incidents/{id}/close Clôturer un incident. 200

Corps d’une mise à jour de statut

{
  "status": "DEGRADED",
  "message": "Markdown text, up to 4096 characters",
  "componentId": "optional UUID",
  "incidentId": "optional UUID of an open incident"
}

status vaut OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE ou OFFLINE, quelle que soit la casse.

Corps d’un incident

{
  "title": "up to 256 characters",
  "status": "CRITICAL",
  "message": "up to 4096 characters",
  "componentId": "optional UUID"
}

Ici, status doit reprendre exactement le nom en majuscules.

Erreurs

Les erreurs sont des documents de problème RFC 7807.

Cause Code de statut
Service, incident ou composant inconnu 404
Saisie invalide, statut inconnu, incident clôturé, clé d’un autre service 400
Action non autorisée 403

Les mises à jour publiées via l’API déclenchent les mêmes emails que celles publiées dans le back-office.