Skip to main content
POST
Check

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

orgId
string
required

The organization's id (UUID) or slug — either form is accepted.

projectId
string
required

The project's id (UUID) or slug — either form is accepted.

domainId
string
required

Response

The domain with its refreshed status.

id
string
required
hostname
string
required
Pattern: ^(?:[a-z0-9](?:[a-z0-9-]{0,61}[a-z0-9])?\.)+[a-z]{2,}$
environment
string
required

Slug of the environment this domain routes to.

Pattern: ^[a-z][a-z0-9-]{0,38}$
status
enum<string>
required

Verification state: pending_dns until the CNAME points at the platform, pending_ssl while the certificate is issued, then active. failed is terminal.

Available options:
pending_dns,
pending_ssl,
active,
failed
verificationErrors
string | null
required

Why verification is stuck, when the edge reported a reason.

createdAt
string<date-time>