Hoe open en sluit ik een incident vanuit een script of deploymentpipeline?
Open er een met POST /api/v1/services/{slug}/incidents, bewaar de teruggegeven id en sluit het met PATCH /api/v1/incidents/{id}/close.
Voordat je begint
- Je hebt een sleutel van de applicatieprogrammeerinterface (API) voor de service.
Stappen
-
Open het incident:
curl -X POST https://statusraptor.com/api/v1/services/acme-cloud/incidents \ -H "Authorization: Bearer $STATUS_RAPTOR_KEY" \ -H "Content-Type: application/json" \ -d '{"title": "Checkout is failing", "status": "CRITICAL", "message": "Investigating."}'Het antwoord bevat
{"id": "<uuid>", "title": "...", "open": true}. -
Sluit het met de teruggegeven
id:curl -X PATCH https://statusraptor.com/api/v1/incidents/<uuid>/close \ -H "Authorization: Bearer $STATUS_RAPTOR_KEY"
Vragen
Waarom moet de status hier in hoofdletters staan?
Bij incidenten moet status de exacte naam in hoofdletters zijn, bijvoorbeeld CRITICAL.
Wat doet sluiten?
Hetzelfde als in de back-office: Status Raptor plaatst „Resolved“-updates en verstuurt de e-mail dat het incident is gesloten.