Resolve an incident
POST/api/v1/incidents/{id}/resolve
Resolves the incident, adds a timeline entry and, when the incident is published, resolves it on the status page too. Resolving it again changes nothing. No request body.
Permission (API-key scope): oncall:alert:respond.
Authorization
bearerAuth(oncall:alert:respond)apiKeyHeader(oncall:alert:respond)
Parameters
Path parameters
idstring requiredThe incident's id.
Responses
200
The incident.
dataIncident requiredShow Incident properties
idstring requiredorg_idstringnumberinteger requiredSequential number within the organization.titlestring requiredsummarystringseverityIncidentSeverity requiredstatusIncidentStatus requiredcommander_idstringstarted_atstring (date-time) requiredidentified_atstring (date-time)resolved_atstring (date-time)timelinearray of IncidentTimelineEntryThe timeline entries, oldest first. Only in the answer of Get an incident.Show IncidentTimelineEntry properties
idstringincident_idstringauthor_idstringstatusstringThe incident's status when the entry was written.messagestringcreated_atstring (date-time)
created_atstring (date-time)updated_atstring (date-time)versionintegerGoes up by one on every edit of the title, summary, severity or commander (not on acknowledge or resolve). Send it with an update to refuse the edit if someone else changed the incident first.
successboolean required
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
404
No incident with this id in your organization (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe request'sX-Request-ID. Quote it to support.
Example request
curl -X POST 'https://evohub.io/api/v1/incidents/2e7f9a1b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/resolve' \
-H 'Authorization: Bearer <TOKEN>'
