REST API

Det Representational State Transfer (REST) applikationsprogrammeringsinterface (API) udgiver statusopdateringer og åbner eller lukker hændelser. Det kan ikke læse data.

Fanen API-nøgler

API-nøgler

  • En nøgle tilhører én tjeneste og kan kun handle på den tjeneste.
  • ADMIN-medlemmer opretter og tilbagekalder nøgler på fanen API-nøgler.
  • Nøglen vises én gang, lige efter at den er genereret. Der gemmes kun en hash.
  • Nøgler udløber ikke. Tilbagekald en nøgle for at stoppe den.

Godkendelse

Send nøglen i en af de to headers:

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

Endpoints

Metode og sti Formål Succes
POST /api/v1/services/{slug}/status Udgive en statusopdatering. 201
POST /api/v1/services/{slug}/incidents Åbne en hændelse med dens første opdatering. 201
PATCH /api/v1/incidents/{id}/close Lukke en hændelse. 200

Indhold af en statusopdatering

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

status er en af OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE, OFFLINE, med vilkårlig brug af store og små bogstaver.

Indhold af en hændelse

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

Her skal status bruge det nøjagtige navn med store bogstaver.

Fejl

Fejl er problemdokumenter efter RFC 7807.

Årsag Statuskode
Ukendt tjeneste, hændelse eller komponent 404
Ugyldigt input, ukendt status, lukket hændelse, nøgle til en anden tjeneste 400
Handling ikke tilladt 403

Opdateringer, der udgives via API’et, udløser de samme e-mails som opdateringer, der udgives i backoffice.