Come pubblico un aggiornamento di stato da uno script?

Invia POST /api/v1/services/{slug}/status con la tua chiave dell’interfaccia di programmazione (API) e un corpo in JavaScript Object Notation (JSON) che contenga uno status e un message.

Prima di iniziare

• Hai una chiave API per il servizio.

Esempio

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."}'

Una chiamata riuscita restituisce 201 e un corpo con id, status e message del nuovo aggiornamento.

Domande

Quali stati posso inviare?

OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE e OFFLINE, con qualsiasi combinazione di maiuscole e minuscole.

Come pubblico per un solo componente?

Aggiungi "componentId": "<uuid>" al corpo. Il componente deve appartenere al servizio.

Come sono gli errori?

Un documento di problema con un codice di stato: 404 per un servizio o componente sconosciuto, 400 per un input non valido o una chiave di un altro servizio. Vedi la tabella nel riferimento dell’API.

Vengono inviate email?

Sì. L’aggiornamento attiva le stesse email agli iscritti di uno pubblicato nel back office.