API Incidents

URL de base : https://api.okstatus.eu/api/v1/incidents — chaque requête nécessite un header Authorization: Bearer oks_live_..., voir Authentification.

Lister les incidents

GET /api/v1/incidents?page=1&per_page=50

{
  "data": [
    {
      "id": "...",
      "title": "...",
      "status": "investigating",
      "severity": "major",
      "monitorId": "..."
    }
  ],
  "meta": { "page": 1, "per_page": 50, "total": 3 }
}

Créer un incident

POST /api/v1/incidents
Content-Type: application/json

Champ	Type	Requis	Description
title	string	✅	1 à 500 caractères
monitorId	string	✅	UUID du monitor concerné
severity	enum		minor, major, critical — minor par défaut

Créer un incident publie automatiquement une première mise à jour investigating. Retourne 201 avec { "data": Incident }.

Récupérer un incident (avec son historique de mises à jour)

GET /api/v1/incidents/:id

{
  "data": {
    "id": "...",
    "title": "...",
    "status": "investigating",
    "severity": "major",
    "updates": [{ "id": "...", "status": "investigating", "message": "...", "createdAt": "..." }]
  }
}

Publier une mise à jour

PATCH /api/v1/incidents/:id
Content-Type: application/json

Champ	Type	Requis	Description
status	enum	✅	investigating, identified, monitoring, ou resolved
message	string	✅	Le texte de la mise à jour, affiché sur la timeline et la page de statut publique

Passer status: "resolved" marque aussi resolvedAt.

Résoudre directement

POST /api/v1/incidents/:id/resolve

Raccourci équivalent à un PATCH avec status: "resolved" et un message par défaut « Incident resolved. » — aucun body requis.

Erreurs

404 NOT_FOUND si l’incident n’existe pas dans votre organisation. Voir Authentification pour le format d’erreur commun et les limites de débit.