Skip to main content
POST
/
api
/
v1
/
status-pages
/
{id}
/
groups
Create a component group
curl --request POST \
  --url https://api.devhelm.io/api/v1/status-pages/{id}/groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "displayOrder": 123,
  "defaultOpen": true
}
'
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "displayOrder": 123,
    "pageOrder": 123,
    "defaultOpen": true,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "components": [
      {
        "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "statusPageId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "name": "<string>",
        "showUptime": true,
        "displayOrder": 123,
        "pageOrder": 123,
        "excludeFromOverall": true,
        "createdAt": "2023-11-07T05:31:56Z",
        "updatedAt": "2023-11-07T05:31:56Z",
        "groupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "description": "<string>",
        "monitorId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "resourceGroupId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "startDate": "2023-11-07T05:31:56Z"
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

Body

application/json
​
name
string
required

Group display name

Maximum string length: 255
​
description
string | null

Optional group description

Maximum string length: 500
​
displayOrder
integer<int32> | null

Position in the group list

​
defaultOpen
boolean | null

Initial expand/collapse state when a visitor first loads the page; renderer may auto-expand on active incidents (default: true)

Response

Created

​
data
object
required