Skip to main content
POST
Create static component

Authorizations

Authorization
string
header
required

API key sent as Authorization: Bearer <key>. Personal keys (gm_pat_) act as you, limited by your role and the key's scopes; organization keys (gm_api_) act for one organization. Send X-Organization-Id with every org-scoped request.

Headers

X-Organization-Id
string
required

ID of the organization to act in. Required with API keys. A user session may omit it and acts in its active organization.

Example:

"k2p9x7w4m1n8b3v6c5z0q2r7"

Path Parameters

statusPageId
string
required

Status page ID.

Body

application/json
name
string
required
Example:

"Payments provider"

startDate
string
required

Date as YYYY-MM-DD.

Pattern: ^\d{4}-\d{2}-\d{2}$
Example:

"2026-09-01"

displayUptime
boolean
required

Show an uptime bar for this component.

description
string
groupId
string

Response

Created

id
string
required
statusPageId
string
required
groupId
string
required
name
string
required
description
string
required
sortOrder
integer
required
startDate
string<date>
required
displayUptime
boolean
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required