Skip to Content
Uptimeify Docs
Status pages

Update Status Page Component

Changes name, description, group, position, uptime bar, manual state or monitor of a component.

PATCH /api/status-pages/{id}/components/{componentId}

Access

Organization admin and editor; customer-bound users (also readonly) and tokens only on self_service pages of their customers, or on managed ones with the customer's canEditManaged exception (otherwise 403 managed_by_organization). 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)

FieldTypeDescription
namestringDisplay name (1-120 chars).
descriptionstring|nullMax 1000 chars. null clears it.
groupIdnumber|string|nullId or publicId of a group of this page. null moves the component out of its group.
sortnumberPosition, 0-100000.
showUptimebooleanShow the availability bar.
manualStatusstringManual components only (or together with sourceKind: "manual"): operational, degraded, partial_outage, major_outage or maintenance.
sourceKindstringmonitor or manual. Switches the component between following a monitor and a state you set yourself. manual drops the monitor link; manualStatus defaults to operational. monitor needs monitorType and monitorId. Not for dependency components.
monitorTypestringTogether with monitorId: the monitor the component follows (http, dns, icmp, smtp, ssh, tcp, ftp, imap_pop). Links another monitor to a monitor component, or with sourceKind: "monitor" turns a manual one into a monitor component. Same rules as on create: a monitor of this organization, of the page's customer if it has one, and within the caller's customer scope.
monitorIdnumberTogether with monitorType.

The component keeps its id, group, subscriptions and incident links when its source changes. A dependency component keeps its provider; delete it and create a new one instead. 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" }'

Follow a monitor instead of a manual state:

curl -X PATCH "$BASE_URL/api/status-pages/1/components/8" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "sourceKind": "monitor", "monitorType": "http", "monitorId": 42 }'

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 invalid
  • 400 Bad Request (statusPageComponentNotManual) when manualStatus is sent for a component that is not (or does not become) manual
  • 400 Bad Request (statusPageComponentSourceInvalid) when sourceKind: "monitor" comes without a monitor for a manual component, a monitor is sent together with sourceKind: "manual", or the component is a dependency component
  • 400 Bad Request (statusPageComponentMonitorCustomerMismatch) when the monitor belongs to another customer than the page
  • 400 Bad Request (invalidIdentifier) when an id in the path is neither a number nor a UUID
  • 401 Unauthorized when you are not logged in
  • 403 Forbidden (forbidden) when your role may not do this, or for a customer-scoped caller on a page without a customer or of another customer
  • 403 Forbidden (statusPagesModuleDisabled) when the status pages module is not activated
  • 404 Not Found (statusPageNotFound) when the status page does not exist or belongs to another organization
  • 404 Not Found (statusPageComponentNotFound) when the component does not exist on this page
  • 404 Not Found (statusPageComponentGroupNotFound) when groupId is not a group of this page
  • 404 Not Found (monitorNotFound) when the monitor does not exist or belongs to another organization
  • 409 Conflict (statusPageComponentMonitorConflict) when the monitor is already a component of this page

On this page