Uptimeify Docs
Status pages

Update Status Page Component Group

Renames, moves or collapses a component group.

PATCH /api/status-pages/{id}/groups/{groupId}

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)

FieldTypeDescription
namestringHeading of the group (1-120 chars).
sortnumberPosition, 0-100000.
collapsedbooleanStart collapsed on the public page.

Example (cURL)

BASE_URL="https://uptimeify.io"
TOKEN="<your-api-token>"

curl -X PATCH "$BASE_URL/api/status-pages/1/groups/3" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{ "collapsed": true }'

Response

200 OK with the updated group, in the same shape as on List Status Page Component Groups.

Common errors

  • 400 Bad Request (invalidRequestBody) when the body is empty or a field is invalid
  • 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 (statusPageComponentGroupNotFound) when the group does not exist on this page

On this page