Skip to main content
POST
/
api
/
v1
/
status-pages
/
{status_page_id}
/
components
Create component
curl --request POST \
  --url https://app.larm.dev/api/v1/status-pages/{status_page_id}/components \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "position": 123,
  "description": "<string>",
  "component_group_id": "<string>",
  "monitors": [
    {}
  ]
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API",
    "description": "REST API endpoints",
    "position": 0,
    "component_group_id": null,
    "monitors": [
      {
        "monitor_id": "660e8400-e29b-41d4-a716-446655440000",
        "down_status": "major_outage"
      }
    ],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T12:00:00Z"
  }
}
Requires status_pages:read_write permission.
​
status_page_id
string
required
Status page UUID
​
name
string
required
Component name (1–255 characters)
​
position
integer
required
Display position (0-indexed)
​
description
string
Optional description
​
component_group_id
string
Optional group UUID to organize components under a heading
​
monitors
object[]
Monitors to link. Each object has monitor_id (monitor UUID) and down_status (major_outage, partial_outage, or degraded_performance). Linked monitors trigger auto-disruptions when they detect failures.
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "API",
    "description": "REST API endpoints",
    "position": 0,
    "component_group_id": null,
    "monitors": [
      {
        "monitor_id": "660e8400-e29b-41d4-a716-446655440000",
        "down_status": "major_outage"
      }
    ],
    "inserted_at": "2026-03-28T12:00:00Z",
    "updated_at": "2026-03-28T12:00:00Z"
  }
}