Wie veröffentliche ich ein Status-Update aus einem Skript?

Sende POST /api/v1/services/{slug}/status mit deinem Schlüssel der Programmierschnittstelle (API) und einem Body im Format JavaScript Object Notation (JSON), der einen status und eine message enthält.

Bevor du anfängst

• Du hast einen API-Schlüssel für den Dienst.

Beispiel

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

Ein erfolgreicher Aufruf liefert 201 und einen Body mit id, status und message des neuen Updates.

Fragen

Welche Status kann ich senden?

OK, DEGRADED, CRITICAL, MONITORING, MAINTENANCE und OFFLINE, in beliebiger Groß- und Kleinschreibung.

Wie veröffentliche ich für eine einzelne Komponente?

Füge "componentId": "<uuid>" zum Body hinzu. Die Komponente muss zum Dienst gehören.

Wie sehen Fehler aus?

Ein Problemdokument mit einem Statuscode: 404 bei unbekanntem Dienst oder unbekannter Komponente, 400 bei ungültiger Eingabe oder einem Schlüssel eines anderen Dienstes. Siehe die Tabelle in der API-Referenz.

Werden E-Mails gesendet?

Ja. Das Update löst dieselben Abonnenten-E-Mails aus wie eines, das im Backoffice veröffentlicht wird.