Skip to main content
PUT
/
api
/
v1
/
status-pages
/
{id}
/
components
/
{componentId}
Update a component
curl --request PUT \
  --url https://api.devhelm.io/api/v1/status-pages/{id}/components/{componentId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "removeFromGroup": true,
  "showUptime": true,
  "displayOrder": 123,
  "excludeFromOverall": true,
  "startDate": "2023-12-25"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "showUptime": true,
    "displayOrder": 123,
    "pageOrder": 123,
    "excludeFromOverall": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "description": "<string>",
    "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "resourceGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "startDate": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

API key (dh_live_...) or Auth0 JWT token

Path Parameters

​
id
string<uuid>
required
​
componentId
string<uuid>
required

Body

application/json
​
name
string | null

New component name; null preserves current

Maximum string length: 255
​
description
string | null

New description; null preserves current, empty string clears

Maximum string length: 500
​
groupId
string<uuid> | null

Move to a different group; null preserves current

​
removeFromGroup
boolean | null

Remove the component from its group (default: false)

​
showUptime
boolean | null

Whether to show the uptime bar; null preserves current

​
displayOrder
integer<int32> | null

New position in the component list; null preserves current

​
excludeFromOverall
boolean | null

Exclude from overall status calculation; null preserves current

​
startDate
string<date> | null

Date from which to start showing uptime; null preserves current. Bars never extend earlier than the underlying monitor's createdAt regardless of value

Response

OK

​
data
object
required