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" }'

• Production

Authorizations

• bearer_auth

Parameters

Path Parameters

status_page_id

required

string format: uuid

Status page identifier

Request Body ^required

Media type application/json

object

domain

required

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

string

Example ^generated

{
  "domain": "example"
}

Responses

200

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

health

One of:

object

The last check of a live domain; absent until the first one, a few minutes after it goes live.

object

checked_at

required

string format: date-time

problem

What to fix, as a sentence. Absent when nothing is wrong.

string | null

certificate_expires_at

When the certificate expires. It renews by itself while the validation record stays in DNS.

string | null format: date-time

null

null

sender

One of:

object

Absent for our own hostnames, which always mail from the default sender.

object

status

required

“not_started” until the domain is provisioned, then “pending”, “verified” or “failed”.

string

dkim_record

required

The CNAME to add. Email is signed for the domain once it resolves.

object

name

required

string

value

required

string

from_address

required

Where the mail comes from once verified.

string

null

null

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",
  "health": {
    "checked_at": "2026-04-15T12:00:00Z",
    "problem": "example",
    "certificate_expires_at": "2026-04-15T12:00:00Z"
  },
  "sender": {
    "status": "example",
    "dkim_record": {
      "name": "example",
      "value": "example"
    },
    "from_address": "example"
  }
}

400

Invalid domain: wildcards, bad characters and siteqwality.com names are refused

401

Missing or invalid authentication

402

The plan’s custom domains are in use; the message names the Custom domain pack

404

Status page not found

409

The domain is taken, or the page already has one

500

Internal server error