Publish an incident to a status page.
POST
/incident/{incident_id}/publish
const url = 'https://api.siteqwality.com/incident/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"status_page_id":"2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.siteqwality.com/incident/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/publish \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status_page_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" }'Links the incident to the status page so it renders publicly. Publishing the same incident to the same page twice is a no-op rather than an error.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” incident_id
required
string format: uuid
Incident identifier
Request Body required
Section titled “Request Body required ” Media type application/json
object
status_page_id
required
string format: uuid
Example generated
{ "status_page_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"}Responses
Section titled “ Responses ”Incident published
Media type application/json
object
id
required
string format: uuid
status_page_id
string | null format: uuid
title
required
string
severity
required
string
status
required
string
responder_status
required
string
service_id
string | null format: uuid
created_at
required
string format: date-time
resolved_at
string | null format: date-time
acknowledged_at
string | null format: date-time
acknowledged_by
string | null format: uuid
auto_created
required
True when the incident was opened automatically by a monitor state change; false for incidents created manually.
boolean
updates
required
Array<object>
object
id
required
string format: uuid
status
required
string
message
required
string
created_at
required
string format: date-time
affected_http_job_ids
required
Array<string>
Example
{ "severity": "minor", "status": "investigating", "responder_status": "triggered", "updates": [ { "status": "investigating" } ]}Missing or invalid authentication
Incident or status page not found
Internal server error