Rename a manual component, change its description, or set its status. Its place, group and visibility are part of the layout.
const url = 'https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0';const options = { method: 'PATCH', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"friendly_name":"example","description":"example","status":"operational"}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request PATCH \ --url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/component/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0 \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "friendly_name": "example", "description": "example", "status": "operational" }'Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ”Status page identifier
Manual component identifier
Request Body required
Section titled “Request Body required ”Fields left out keep their values.
object
Up to 256 characters.
Up to 200 characters. null clears it.
Responses
Section titled “ Responses ”The updated component
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
Missing or invalid authentication
Status page not found, or no manual component with this id on it
Internal server error