Skip to main content
PATCH
/
api
/
v1
/
status-pages
/
{status_page_id}
/
components
/
{id}
Update component
curl --request PATCH \
  --url https://app.larm.dev/api/v1/status-pages/{status_page_id}/components/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "position": 123,
  "component_group_id": "<string>",
  "monitors": [
    {}
  ]
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API v2",
    "description": "Updated API",
    "position": 0,
    "component_group_id": null,
    "monitors": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}
Requires status_pages:read_write permission.
​
status_page_id
string
required
Status page UUID
​
id
string
required
Component UUID
​
name
string
Component name
​
description
string
Component description
​
position
integer
Display position
​
component_group_id
string
Group UUID
​
monitors
object[]
Replaces all linked monitors. Each object has id (monitor UUID) and down_status.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API v2",
    "description": "Updated API",
    "position": 0,
    "component_group_id": null,
    "monitors": [],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T13:00:00Z"
  }
}