REST-API
Die Representational State Transfer (REST) Programmierschnittstelle (API) veröffentlicht Status-Updates und meldet oder schließt Vorfälle. Daten lesen kann sie nicht.
API-Schlüssel
- Ein Schlüssel gehört zu einem Dienst und kann nur für diesen Dienst handeln.
- ADMIN-Mitglieder erstellen und widerrufen Schlüssel im Tab API-Schlüssel.
- Der Schlüssel wird einmal angezeigt, direkt nach dem Erzeugen. Gespeichert wird nur ein Hash.
- Schlüssel laufen nicht ab. Widerrufe einen Schlüssel, damit er nicht mehr funktioniert.
Authentifizierung
Sende den Schlüssel in einem der beiden Header:
Authorization: Bearer <key>
X-Api-Key: <key>
Endpunkte
| Methode und Pfad | Zweck | Erfolg |
|---|---|---|
POST /api/v1/services/{slug}/status |
Ein Status-Update veröffentlichen. | 201 |
POST /api/v1/services/{slug}/incidents |
Einen Vorfall mit seinem ersten Update melden. | 201 |
PATCH /api/v1/incidents/{id}/close |
Einen Vorfall schließen. | 200 |
Body eines Status-Updates
{
"status": "DEGRADED",
"message": "Markdown text, up to 4096 characters",
"componentId": "optional UUID",
"incidentId": "optional UUID of an open incident"
}
status ist einer von OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE, OFFLINE, in beliebiger Groß- und Kleinschreibung.
Body eines Vorfalls
{
"title": "up to 256 characters",
"status": "CRITICAL",
"message": "up to 4096 characters",
"componentId": "optional UUID"
}
Hier muss status den exakten Namen in Großbuchstaben verwenden.
Fehler
Fehler sind RFC-7807-Problemdokumente.
| Ursache | Statuscode |
|---|---|
| Unbekannter Dienst, Vorfall oder unbekannte Komponente | 404 |
| Ungültige Eingabe, unbekannter Status, geschlossener Vorfall, Schlüssel eines anderen Dienstes | 400 |
| Aktion nicht erlaubt | 403 |
Über die API veröffentlichte Updates lösen dieselben E-Mails aus wie Updates, die im Backoffice veröffentlicht werden.