API-referentie voor incidenten
Alle incidenten van een pagina ophalen
Endpoint:
GET /v1/:page_id/incidents?page=:page&per_page=:per_page
- Het standaard paginanummer is 1.
- De standaardwaarde voor per_page is 50; het maximum is 100 items per pagina.
Voorbeeldrespons:
[{"id": "ckf01m59ueaqb0a32wrljz1yd","name": "Rocket is going down","started": "2020-09-12T19:05:17.398Z","status": "RESOLVED","resolved": "2020-09-12T19:09:04.498Z","updates": [{"id": "ckf01m5ioeaqi0a32jtv8ovp8","message": "We are currently investigating this incident.","messageHtml": "<p>We are currently investigating this incident.</p>","status": "INVESTIGATING","notify": true,"started": "2020-09-12T19:05:17.398Z","ended": null,"duration": 228,"createdAt": "2020-09-12T19:08:50.160Z"},{"id": "ckf01mnk9eaui0a32mmhgq68g","message": "This incident has been resolved.","messageHtml": "<p>This incident has been resolved.</p>","status": "RESOLVED","notify": true,"started": "2020-09-12T19:09:04.498Z","ended": null,"duration": null,"createdAt": "2020-09-12T19:09:13.545Z"}],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "PARTIALOUTAGE","showUptime": true,"site": {"id": "ckf01fonve9i40a32oas5b0uw","name": "Nasa","subdomain": "nasa","color": null,"logoUrl": null,"publicEmail": null},"customImpactPercentage": 40}],"user": {"id": "ckf01g7m4eaqb0a32fl7jl1xx","name": "Buzz Aldrin","email": "buzz@nasa.com"}}]
Je kunt de query-parameters status en !status toevoegen om de resultaten te beperken tot incidenten die wel respectievelijk niet een van de door komma's gescheiden statussen hebben.
user is het lid van de workspace dat het incident heeft aangemaakt. De waarde is null wanneer het incident automatisch is aangemaakt (door een monitor, een externe integratie of per e-mail).
Een incident ophalen
Endpoint:
GET /v1/:page_id/incidents/:incident_id
Voorbeeldrespons:
{"id": "ckf01m59ueaqb0a32wrljz1yd","name": "Rocket is going down","status": "RESOLVED","started": "2020-09-12T19:05:17.398Z","resolved": "2020-09-12T19:09:04.498Z","updates": [{"id": "ckf01m5ioeaqi0a32jtv8ovp8","message": "We are currently investigating this incident.","messageHtml": "<p>We are currently investigating this incident.</p>","status": "INVESTIGATING","notify": true,"started": "2020-09-12T19:05:17.398Z","ended": null,"duration": 228,"createdAt": "2020-09-12T19:08:50.160Z"},{"id": "ckf01mnk9eaui0a32mmhgq68g","message": "This incident has been resolved.","messageHtml": "<p>This incident has been resolved.</p>","status": "RESOLVED","notify": true,"started": "2020-09-12T19:09:04.498Z","ended": null,"duration": null,"createdAt": "2020-09-12T19:09:13.545Z"}],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "MAJOROUTAGE","showUptime": true,"site": {"id": "ckf01fonve9i40a32oas5b0uw","name": "Nasa","subdomain": "nasa","color": null,"logoUrl": null,"publicEmail": null}}],"user": {"id": "ckf01g7m4eaqb0a32fl7jl1xx","name": "Buzz Aldrin","email": "buzz@nasa.com"}}
Een incident toevoegen
Endpoint:
POST /v1/:page_id/incidents
Voorbeeldverzoek:
{"name": "Test incident","message": "We're currently investigating an issue with the Website","components": ["ckf01fvnxywz50a35nh1qzssm"],"started": "2020-09-12 05:38:47.998","status": "INVESTIGATING","notify": true,"statuses": [{"id": "ckf01fvnxywz50a35nh1qzssm","status": "PARTIALOUTAGE","customImpactPercentage": 40}],"translations": {"name": {"fr": "Incident de test"},"message": {"fr": "Nous enquêtons actuellement sur un problème avec le site Web"}}}
Incidenten worden standaard op je statuspagina gepubliceerd.
Wil je een niet-gepubliceerd incident aanmaken, stuur dan shouldPublish mee met de waarde false.
Voorbeeldrespons:
{"id": "ckf02l5m8z36j0a35qr9q1tq1","name": "Test incident","status": "INVESTIGATING","started": "2020-09-12T03:38:47.998Z","resolved": null,"updates": [],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true,"site": {"id": "ckf01fonve9i40a32oas5b0uw","name": "Nasa","subdomain": "nasa","color": null,"logoUrl": null,"publicEmail": null}}],"translations": {"name": {"fr": "Incident de test"},"message": {"fr": "Nous enquêtons actuellement sur un problème avec le site Web"}}}
Een incident toevoegen met een sjabloon
Endpoint:
POST /v1/:page_id/incidents/:template
Voorbeeldrespons:
{"id": "cl8hrdsdsasu441sv26yq","name": "Investigating Template","nameTranslationId": null,"notify": false,"status": "INVESTIGATING","started": "2022-09-25T19:53:20.778Z","resolved": null,"duration": null,"createdAt": "2022-09-25T19:53:20.800Z","updatedAt": "2022-09-25T19:53:20.800Z","automated": false,"impact": "MAJOROUTAGE","appId": null,"siteId": "cl8hadasdasd6wkxdco","importedFrom": null}
Een incident bijwerken
Endpoint:
PUT /v1/:page_id/incidents/:incident_id
Voorbeeldverzoek:
{"name": "Test incident 2","components": ["ckf01fvnxywz50a35nh1qzssm"],"started": "2020-09-12 05:38:47.998","status": "INVESTIGATING","notify": true,"statuses": [{"id": "ckf01fvnxywz50a35nh1qzssm","status": "OPERATIONAL"}],"translations": {"name": {"fr": "Incident de test"},"message": {"fr": "Nous enquêtons actuellement sur un problème avec le site Web"}}}
Voorbeeldrespons:
{"id": "ckf02l5m8z36j0a35qr9q1tq1","name": "Test incident 2","status": "INVESTIGATING","started": "2020-09-12T03:38:47.998Z","resolved": null,"updates": [],"components": [{"id": "ckf01fvnxywz50a35nh1qzssm","name": "Website","status": "OPERATIONAL","showUptime": true,"site": {"id": "ckf01fonve9i40a32oas5b0uw","name": "Nasa","subdomain": "nasa","color": null,"logoUrl": null,"publicEmail": null}}],"translations": {"name": {"fr": "Incident de test"},"message": {"fr": "Nous enquêtons actuellement sur un problème avec le site Web"}}}
Een incident verwijderen
Endpoint:
DELETE /v1/:page_id/incidents/:incident_id
Voorbeeldrespons:
{"id": "ckf02l5m8z36j0a35qr9q1tq1"}
Responders van een incident ophalen
Wie er via on-call is opgeroepen voor een incident, of iemand het al heeft bevestigd en wie het leidt.
Endpoint:
GET /v1/:page_id/incidents/:incident_id/responders
Voorbeeldrespons:
{"incidentId": "ckf02l5m8z36j0a35qr9q1tq1","paged": true,"acknowledged": true,"lead": {"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com"},"pages": [{"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com","pagedAt": "2026-11-01T12:01:00.000Z"}],"responders": [{"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com","status": "ACKNOWLEDGED","acknowledgedAt": "2026-11-01T12:05:00.000Z","declinedAt": null}]}
Een incident bevestigen
Bevestig een incident als de gebruiker van de API-sleutel. De eerste bevestiging annuleert elke escalatie die nog wacht om meer mensen op te roepen, en maakt die persoon de leider van het incident als er nog geen is. Op de statuspagina verandert niets. Opnieuw bevestigen kan geen kwaad: alreadyAcknowledged is dan true.
Endpoint:
POST /v1/:page_id/incidents/:incident_id/acknowledge
Voorbeeldrespons:
{"incidentId": "ckf02l5m8z36j0a35qr9q1tq1","alreadyAcknowledged": false,"paged": true,"acknowledged": true,"lead": {"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com"},"pages": [{"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com","pagedAt": "2026-11-01T12:01:00.000Z"}],"responders": [{"teamMemberId": "clh8nmaan72592bfokqjqd95s1","name": "Sam Rivera","email": "sam@example.com","status": "ACKNOWLEDGED","acknowledgedAt": "2026-11-01T12:05:00.000Z","declinedAt": null}]}