REST-API

Representational State Transfer (REST) programmeringsgrensesnittet (API) publiserer statusoppdateringer og åpner eller lukker hendelser. Det kan ikke lese data.

Fanen API-nøkler

API-nøkler

  • En nøkkel tilhører én tjeneste og kan bare handle på den tjenesten.
  • ADMIN-medlemmer oppretter og trekker tilbake nøkler på fanen API-nøkler.
  • Nøkkelen vises én gang, rett etter at den er generert. Det lagres bare en hash.
  • Nøkler utløper ikke. Trekk tilbake en nøkkel for å stoppe den.

Autentisering

Send nøkkelen i en av de to headerne:

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

Endepunkter

Metode og sti Formål Suksess
POST /api/v1/services/{slug}/status Publisere en statusoppdatering. 201
POST /api/v1/services/{slug}/incidents Åpne en hendelse med den første oppdateringen. 201
PATCH /api/v1/incidents/{id}/close Lukke en hendelse. 200

Innhold i en statusoppdatering

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

status er en av OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE, OFFLINE, med vilkårlig bruk av store og små bokstaver.

Innhold i en hendelse

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

Her må status bruke det eksakte navnet med store bokstaver.

Feil

Feil er problemdokumenter etter RFC 7807.

Årsak Statuskode
Ukjent tjeneste, hendelse eller komponent 404
Ugyldig inndata, ukjent status, lukket hendelse, nøkkel for en annen tjeneste 400
Handling ikke tillatt 403

Oppdateringer som publiseres via API-et, utløser de samme e-postene som oppdateringer som publiseres i backoffice.