Skip to main content
POST
/
api
/
v1
/
status-pages
Create a status page
curl --request POST \
  --url https://api.devhelm.io/api/v1/status-pages \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "slug": "<string>",
  "description": "<string>",
  "visibility": "PUBLIC",
  "enabled": true,
  "incidentMode": "MANUAL"
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "organizationId": 123,
    "workspaceId": 123,
    "name": "<string>",
    "slug": "<string>",
    "branding": {
      "hidePoweredBy": true,
      "logoUrl": "<string>",
      "faviconUrl": "<string>",
      "brandColor": "<string>",
      "pageBackground": "<string>",
      "cardBackground": "<string>",
      "textColor": "<string>",
      "borderColor": "<string>",
      "headerStyle": "<string>",
      "theme": "<string>",
      "reportUrl": "<string>",
      "customCss": "<string>",
      "customHeadHtml": "<string>"
    },
    "visibility": "PUBLIC",
    "enabled": true,
    "incidentMode": "MANUAL",
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "componentCount": 123,
    "subscriberCount": 123,
    "overallStatus": "OPERATIONAL"
  }
}

Authorizations

Authorization
string
header
required

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

Body

application/json
name
string
required

Human-readable name for this status page

Maximum string length: 255
slug
string
required

URL slug (lowercase, hyphens, globally unique)

Required string length: 3 - 63
Pattern: ^[a-z0-9][a-z0-9-]*[a-z0-9]$
description
string | null

Optional description shown below the page header

Maximum string length: 500
branding
object

Updated branding configuration; null preserves current

visibility
enum<string> | null

Page visibility: PUBLIC, PASSWORD, or IP_RESTRICTED (default: PUBLIC)

Available options:
PUBLIC,
PASSWORD,
IP_RESTRICTED
enabled
boolean | null

Whether the page is enabled (default: true)

incidentMode
enum<string> | null

Incident mode: MANUAL, REVIEW, or AUTOMATIC (default: AUTOMATIC)

Available options:
MANUAL,
REVIEW,
AUTOMATIC

Response

201 - */*

Created

data
object
required