Hur publicerar jag en statusuppdatering från ett skript?
Skicka POST /api/v1/services/{slug}/status med din nyckel för programmeringsgränssnittet (API) och en JavaScript Object Notation (JSON) body med en status och ett message.
Innan du börjar
- Du har en API-nyckel för tjänsten.
Exempel
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."}'
Ett lyckat anrop returnerar 201 och en body med den nya uppdateringens id, status och message.
Frågor
Vilka statusar kan jag skicka?
OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE och OFFLINE, med valfri användning av stora och små bokstäver.
Hur publicerar jag för en enskild komponent?
Lägg till "componentId": "<uuid>" i body. Komponenten måste tillhöra tjänsten.
Hur ser fel ut?
Ett problemdokument med en statuskod: 404 för en okänd tjänst eller komponent, 400 för ogiltig inmatning eller en nyckel från en annan tjänst. Se tabellen i API-referensen.
Skickas e-postmeddelanden?
Ja. Uppdateringen utlöser samma prenumerant-e-postmeddelanden som en uppdatering som publiceras i backoffice.