On-Call API › Status page publishing
Get publishing state
GET/api/v1/incidents/{id}/publish
Whether the incident is published to a status page, and where. An incident
that is not published answers {"published": false}.
Permission (API-key scope): oncall:incident:read.
Authorization
bearerAuth(oncall:incident:read)apiKeyHeader(oncall:incident:read)
Parameters
Path parameters
idstring requiredThe incident's id.
Responses
200
The publishing state.
dataIncidentPublication requiredShow IncidentPublication properties
publishedboolean requiredstatus_page_idstringstatus_incident_idstringThe incident's id on the status page.
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.
403
The key lacks the scope this endpoint needs (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
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.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.
Example request
curl -X GET 'https://evohub.io/api/v1/incidents/2e7f9a1b-3c4d-4e5f-8a9b-0c1d2e3f4a5b/publish' \
-H 'Authorization: Bearer <TOKEN>'