Update Status Page Component
Changes name, description, group, position, uptime bar or manual state of a component.
PATCH /api/status-pages/{id}/components/{componentId}
Access
Organization admin and editor. A customer-scoped user or API token only reaches pages of a customer in its scope; a page without a customer (customerId: null) answers it with 403 (forbidden). A page of another organization answers 404 (statusPageNotFound). Path ids take the numeric id or the publicId. The change is written to the organization's audit log.
Request Body (all optional, at least one field)
| Field | Type | Description |
|---|---|---|
name | string | Display name (1-120 chars). |
description | string|null | Max 1000 chars. null clears it. |
groupId | number|string|null | Id or publicId of a group of this page. null moves the component out of its group. |
sort | number | Position, 0-100000. |
showUptime | boolean | Show the availability bar. |
manualStatus | string | Manual components only: operational, degraded, partial_outage, major_outage or maintenance. |
sourceKind and the monitor of a component cannot be changed; delete the component and create a new one. To move many components at once, use Reorder Status Page Components.
Example (cURL)
BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"
curl -X PATCH "$BASE_URL/api/status-pages/1/components/8" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{ "manualStatus": "partial_outage" }'Response
200 OK with the updated component, in the same shape as on List Status Page Components.
Common errors
400 Bad Request(invalidRequestBody) when the body is empty or a field is invalid400 Bad Request(statusPageComponentNotManual) whenmanualStatusis sent for a monitor component400 Bad Request(invalidIdentifier) when an id in the path is neither a number nor a UUID401 Unauthorizedwhen you are not logged in403 Forbidden(forbidden) when your role may not do this, or for a customer-scoped caller on a page without a customer or of another customer403 Forbidden(statusPagesModuleDisabled) when the status pages module is not activated404 Not Found(statusPageNotFound) when the status page does not exist or belongs to another organization404 Not Found(statusPageComponentNotFound) when the component does not exist on this page404 Not Found(statusPageComponentGroupNotFound) whengroupIdis not a group of this page