Hoe plaats ik een statusupdate vanuit een script?

Stuur POST /api/v1/services/{slug}/status met je sleutel van de applicatieprogrammeerinterface (API) en een JavaScript Object Notation (JSON) body met een status en een message.

Voordat je begint

• Je hebt een API-sleutel voor de service.

Voorbeeld

curl -X POST https://statusraptor.com/api/v1/services/acme-cloud/status \
  -H "Authorization: Bearer $STATUS_RAPTOR_KEY" \
  -H "Content-Type: application/json" \
  -d '{"status": "DEGRADED", "message": "API latency is elevated."}'

Een geslaagde aanroep geeft 201 terug en een body met id, status en message van de nieuwe update.

Vragen

Welke statussen kan ik sturen?

OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE en OFFLINE, in elke combinatie van hoofdletters en kleine letters.

Hoe plaats ik voor één component?

Voeg "componentId": "<uuid>" toe aan de body. Het component moet bij de service horen.

Hoe zien fouten eruit?

Een probleemdocument met een statuscode: 404 voor een onbekende service of onbekend component, 400 voor ongeldige invoer of een sleutel van een andere service. Zie de tabel in de API-referentie.

Worden er e-mails verstuurd?

Ja. De update veroorzaakt dezelfde e-mails aan abonnees als een update die in de back-office is geplaatst.