Skip to content

Provision a custom domain for a status page.

POST
/status_page/{status_page_id}/custom_domain
curl --request POST \
--url https://api.siteqwality.com/status_page/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/custom_domain \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "domain": "example" }'
status_page_id
required
string format: uuid

Status page identifier

Media type application/json
object
domain
required

The customer’s custom domain, e.g. “status.theircompany.com”

string
Example generated
{
"domain": "example"
}

Custom domain provisioned with DNS validation records

Media type application/json

Response shape for GET/POST /status-pages/{id}/custom-domain

object
status_page_id
required
string
domain
required
string
status
required

“pending_validation” | “provisioning” | “active” | “failed” | “deleting”

string
cname_target
required

The intermediate CNAME the customer must point their domain at, e.g. “<status_page_id>.custom.siteqwality.com”

string
acm_validation
required

ACM DNS validation records — needed while status = “pending_validation”

object
name
required

The CNAME record name the customer must create, e.g. “_abc123.status.theircompany.com”

string
value
required

The CNAME record value to point at, e.g. “xyz.acm-validations.aws”

string
failure_reason
string | null
created_at
required
string format: date-time
updated_at
required
string format: date-time
Example generated
{
"status_page_id": "example",
"domain": "example",
"status": "example",
"cname_target": "example",
"acm_validation": {
"name": "example",
"value": "example"
},
"failure_reason": "example",
"created_at": "2026-04-15T12:00:00Z",
"updated_at": "2026-04-15T12:00:00Z"
}

Invalid domain

Missing or invalid authentication

Internal server error