REST API
Representational State Transfer (REST) -ohjelmointirajapinta (API) julkaisee tilapäivityksiä sekä avaa ja sulkee häiriöitä. Se ei voi lukea tietoja.
API-avaimet
- Avain kuuluu yhdelle palvelulle ja voi toimia vain sen palvelun puolesta.
- ADMIN-jäsenet luovat ja kumoavat avaimia API-avaimet-välilehdellä.
- Avain näytetään kerran, heti luomisen jälkeen. Vain tiiviste tallennetaan.
- Avaimet eivät vanhene. Kumoa avain, jotta se lakkaa toimimasta.
Todennus
Lähetä avain jommassakummassa otsikossa:
Authorization: Bearer <key>
X-Api-Key: <key>
Päätepisteet
| Menetelmä ja polku | Tarkoitus | Onnistuminen |
|---|---|---|
POST /api/v1/services/{slug}/status |
Julkaise tilapäivitys. | 201 |
POST /api/v1/services/{slug}/incidents |
Avaa häiriö ensimmäisine päivityksineen. | 201 |
PATCH /api/v1/incidents/{id}/close |
Sulje häiriö. | 200 |
Tilapäivityksen runko
{
"status": "DEGRADED",
"message": "Markdown text, up to 4096 characters",
"componentId": "optional UUID",
"incidentId": "optional UUID of an open incident"
}
status on jokin seuraavista: OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE, OFFLINE, isoin tai pienin kirjaimin.
Häiriön runko
{
"title": "up to 256 characters",
"status": "CRITICAL",
"message": "up to 4096 characters",
"componentId": "optional UUID"
}
Tässä status-kentässä on käytettävä tarkkaa nimeä isoilla kirjaimilla.
Virheet
Virheet ovat RFC 7807 -ongelmadokumentteja.
| Syy | Tilakoodi |
|---|---|
| Tuntematon palvelu, häiriö tai komponentti | 404 |
| Virheellinen syöte, tuntematon tila, suljettu häiriö, toisen palvelun avain | 400 |
| Toiminto ei ole sallittu | 403 |
API:n kautta julkaistut päivitykset aiheuttavat samat sähköpostit kuin hallintapaneelissa julkaistut päivitykset.