Force the public status of any component on the page, with an optional note and expiry.
const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/override';const options = { method: 'PUT', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"status":"operational","note":"example","expires_at":"2026-04-15T12:00:00Z"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PUT \ --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/override \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "status": "operational", "note": "example", "expires_at": "2026-04-15T12:00:00Z" }'The override wins over the monitor’s own state, pauses and maintenance, and counts toward the page’s headline. Setting it again replaces it.
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Status page identifier
The component’s id from the page layout
Request Body required
Section titled “Request Body required ”object
What the public page shows for this component, whatever its monitor says.
Shown next to the status on the public page. Up to 500 characters, one line.
When the override lapses on its own. Must be in the future. Leave out to keep it until cleared.
Responses
Section titled “ Responses ”The component with its override
A component on the page, as the page shows it.
object
What the layout and the component routes call it: the HTTP job, browser check or cron job id, or the manual component’s own id.
The same value as id, kept for clients that predate manual components.
One line shown under the name, or null.
A hidden component stays on the page’s list but is left off the public page.
False shows the status only, with no uptime bars or percentage. Heartbeats and manual components never show uptime.
The override in force, or null. One past its expiry reads as null.
object
What the owner says a component is doing: a manual component’s status, or an override on any
component. Stored as text (status_page_components.manual_status, *.override_status).
When it lapses on its own, or null to keep it until cleared.
Example
{ "kind": "http_job", "status": "operational", "status_override": { "status": "operational" }}Invalid request body, a note that is too long, or an expiry in the past
Missing or invalid authentication
Status page not found, or the component is not on it
Internal server error