REST-API
Representational State Transfer (REST) programmeringsgränssnittet (API) publicerar statusuppdateringar och öppnar eller stänger incidenter. Det kan inte läsa data.
API-nycklar
- En nyckel tillhör en tjänst och kan bara agera för den tjänsten.
- ADMIN-medlemmar skapar och återkallar nycklar på fliken API-nycklar.
- Nyckeln visas en gång, direkt efter att den har genererats. Bara en hash sparas.
- Nycklar förfaller inte. Återkalla en nyckel för att få den att sluta fungera.
Autentisering
Skicka nyckeln i en av de två rubrikerna:
Authorization: Bearer <key>
X-Api-Key: <key>
Slutpunkter
| Metod och sökväg | Syfte | Lyckat |
|---|---|---|
POST /api/v1/services/{slug}/status |
Publicera en statusuppdatering. | 201 |
POST /api/v1/services/{slug}/incidents |
Öppna en incident med dess första uppdatering. | 201 |
PATCH /api/v1/incidents/{id}/close |
Stänga en incident. | 200 |
Innehåll i en statusuppdatering
{
"status": "DEGRADED",
"message": "Markdown text, up to 4096 characters",
"componentId": "optional UUID",
"incidentId": "optional UUID of an open incident"
}
status är en av OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE, OFFLINE, med valfri användning av stora och små bokstäver.
Innehåll i en incident
{
"title": "up to 256 characters",
"status": "CRITICAL",
"message": "up to 4096 characters",
"componentId": "optional UUID"
}
Här måste status använda det exakta namnet med versaler.
Fel
Fel är problemdokument enligt RFC 7807.
| Orsak | Statuskod |
|---|---|
| Okänd tjänst, incident eller komponent | 404 |
| Ogiltig inmatning, okänd status, stängd incident, nyckel för en annan tjänst | 400 |
| Åtgärden är inte tillåten | 403 |
Uppdateringar som publiceras via API:et utlöser samma e-postmeddelanden som uppdateringar som publiceras i backoffice.