Skip to main content
POST
Create status page

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"

Body

application/json
name
string
required

Display name.

Example:

"Acme Status"

visibility
enum<string>
required

public pages are open to anyone; private pages require a signed-in member.

Available options:
public,
private
domain
string
required

Subdomain slug: lowercase letters, numbers and hyphens. Must be unique; check with GET /api/v1/status-pages/domain/availability.

Pattern: ^[a-z0-9-]+$
Example:

"acme"

description
string

Optional description.

Response

Created

id
string
required
name
string
required
domain
string
required
customDomain
string | null
required
customDomainVerified
boolean
required
vercelVerificationStatus
string | null
required
vercelVerificationError
string | null
required
vercelLastCheckedAt
string | null
required
description
string
required
logoUrl
string | null
required
visibility
string
required
userId
string
required
organizationId
string
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required