Skip to main content
PATCH
/
api
/
v1
/
status-pages
/
{id}
Update status page
curl --request PATCH \
  --url https://app.larm.dev/api/v1/status-pages/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "theme": "<string>",
  "primary_color": "<string>",
  "logo_light_url": "<string>",
  "logo_dark_url": "<string>",
  "show_theme_switcher": true,
  "enabled": true,
  "subscribers_enabled": true
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "dark",
    "primary_color": "#4F46E5",
    "enabled": true,
    "subscribers_enabled": true,
    "custom_domain": null,
    "domain_status": "none",
    "logo_light_url": null,
    "logo_dark_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T14:30:00Z"
  }
}
Requires status_pages:read_write permission. Only include the fields you want to change. Updates only the page’s own fields. To modify components and groups, use the dedicated CRUD endpoints or replace the entire structure with PUT structure. To attach a custom domain, use the custom-domain endpoint (separate from this one).
​
id
string
required
Status page ID (UUID)
​
name
string
Page name (1–255 characters)
​
slug
string
URL identifier (3–63 characters, lowercase alphanumeric and hyphens; cannot start or end with a hyphen)
​
description
string
Brief description (up to 1000 characters)
​
theme
string
system, light, or dark
​
primary_color
string
Brand color in hex format (e.g. #4F46E5)
​
logo_light_url
string
URL of the logo to use on light backgrounds
​
logo_dark_url
string
URL of the logo to use on dark backgrounds
​
show_theme_switcher
boolean
Show a light/dark theme switcher on the public page
​
enabled
boolean
Whether the page is publicly visible
​
subscribers_enabled
boolean
Allow email subscriptions
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Acme Status",
    "slug": "acme",
    "description": "Current status of Acme services",
    "theme": "dark",
    "primary_color": "#4F46E5",
    "enabled": true,
    "subscribers_enabled": true,
    "custom_domain": null,
    "domain_status": "none",
    "logo_light_url": null,
    "logo_dark_url": null,
    "url": "https://acme.status.larm.dev",
    "components": [],
    "inserted_at": "2025-03-01T12:00:00Z",
    "updated_at": "2025-03-01T14:30:00Z"
  }
}