Skip to main content
POST
/
api
/
v1
/
status-pages
Create status page
curl --request POST \
  --url https://app.larm.dev/api/v1/status-pages \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "theme": "<string>",
  "primary_color": "<string>",
  "enabled": true,
  "subscribers_enabled": true,
  "components": [
    {}
  ]
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "system",
    "primary_color": null,
    "enabled": true,
    "subscribers_enabled": false,
    "custom_domain": null,
    "domain_status": "none",
    "logo_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [
      {
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "monitor_id": "550e8400-e29b-41d4-a716-446655440000",
        "display_name": "Website",
        "position": 0
      }
    ],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}
Requires status_pages:read_write permission.
​
name
string
required
Page name (1–255 characters)
​
slug
string
required
URL identifier (3–63 characters, lowercase alphanumeric and hyphens)
​
description
string
Brief description (up to 1000 characters)
​
theme
string
default:"system"
system, light, or dark
​
primary_color
string
Brand color in hex format (e.g. #4F46E5)
​
enabled
boolean
default:false
Whether the page is publicly visible
​
subscribers_enabled
boolean
default:false
Allow email subscriptions
​
components
object[]
Monitors to display on the page. Each object has monitor_id (UUID, required), display_name (string, required), and position (integer, required).
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "system",
    "primary_color": null,
    "enabled": true,
    "subscribers_enabled": false,
    "custom_domain": null,
    "domain_status": "none",
    "logo_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [
      {
        "id": "770e8400-e29b-41d4-a716-446655440000",
        "monitor_id": "550e8400-e29b-41d4-a716-446655440000",
        "display_name": "Website",
        "position": 0
      }
    ],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T12:00:00Z"
  }
}