StatusDashboard
DashboardsDomains

Get dashboard domains

Retrieve the subdomain and custom domain settings for a dashboard.

View Markdown

GET /app/dashboards/{id}/domains

Returns the current subdomain and custom domain configuration for a dashboard. Requires admin role.


Path parameters

ParameterDescription
idThe UUID of the dashboard.

Request

See API Basics for required headers.

This endpoint takes no request body.


Sample request

curl https://api.statusdashboard.com/app/dashboards/a1b2c3d4-e5f6-7890-abcd-ef1234567890/domains \
  -H "Authorization: Bearer bcf847abf5c6:def456"

Sample response

Status: 200 OK

{
  "subdomain": "acme",
  "customDomain": "status.acme.com",
  "customDomainStatus": "active"
}

Response fields

FieldTypeDescription
subdomainstringThe subdomain slug (e.g. acme maps to acme.yourdomain.com).
customDomainstringThe custom domain, if configured. Absent when no custom domain is set.
customDomainStatusstringOne of awaiting_dns, validating, active, removing, failed. Absent when no custom domain is set.
customDomainErrorstringHuman-readable error when customDomainStatus is failed, or when verification was lost and status is awaiting_dns.
customDomainCreatedAtstringISO 8601 timestamp when the custom domain was first saved.
customDomainUpdatedAtstringISO 8601 timestamp of the last custom domain status change.
cloudFrontTenantIdstringInternal provisioning identifier. Present after activation has been requested at least once.

Error responses

StatusWhen
403Insufficient permissions.
404Dashboard not found or does not belong to the caller's organization.

On this page

We use cookies

We use essential cookies to keep the site working, and optional analytics cookies to understand how it's used. Read our Privacy Policy.