Skip to content

Publish an incident to a status page.

POST
/incident/{incident_id}/publish
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.

incident_id
required
string format: uuid

Incident identifier

Media type application/json
object
status_page_id
required
string format: uuid
Example generated
{
"status_page_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
}

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
Allowed values: minor major critical
status
required
string
Allowed values: investigating identified monitoring resolved
responder_status
required
string
Allowed values: triggered acknowledged resolved
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
Allowed values: investigating identified monitoring resolved
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