API Vorfälle

Basis-URL: https://api.okstatus.eu/api/v1/incidents — jede Anfrage braucht einen Header Authorization: Bearer oks_live_..., siehe Authentifizierung.

Vorfälle auflisten

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 }
}

Einen Vorfall anlegen

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

Feld	Typ	Pflicht	Beschreibung
title	string	✅	1–500 Zeichen
monitorId	string	✅	UUID des betroffenen Monitors
severity	enum		minor, major, critical — Standard ist minor

Das Anlegen eines Vorfalls veröffentlicht automatisch eine erste Aktualisierung mit Status investigating. Antwortet mit 201 und { "data": Incident }.

Einen Vorfall abrufen (mit seiner Zeitleiste)

GET /api/v1/incidents/:id

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

Eine Aktualisierung veröffentlichen

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

Feld	Typ	Pflicht	Beschreibung
status	enum	✅	investigating, identified, monitoring oder resolved
message	string	✅	Der Text der Aktualisierung, sichtbar in der Zeitleiste und auf der öffentlichen Statusseite

status: "resolved" setzt zusätzlich resolvedAt.

Direkt auflösen

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

Abkürzung für PATCH mit status: "resolved" und einer Standardmeldung „Incident resolved.” — ohne Body.

Fehler

404 NOT_FOUND, wenn der Vorfall in Ihrer Organisation nicht existiert. Gemeinsames Fehlerformat und Ratenbegrenzung: siehe Authentifizierung.