Skip to main content
POST
Add a domain

Authorizations

Authorization
string
header
required

Project API key. Server-side only.

Path Parameters

projectId
string
required
Pattern: ^prj_[A-Za-z0-9]+$

Body

application/json
hostname
string<hostname>
required

Exact host name, without scheme or path.

Example:

"courses.example.com"

Response

Domain added.

id
string
required
Example:

"dom_7pW1cX"

hostname
string
required

Lowercase hostname. Playback matches this exact host only (see Playback in the API description); a subdomain needs its own domain.

Example:

"courses.example.com"

status
enum<string>
required
Available options:
pending,
verified
verification
object
required

Create this DNS record to prove you own the domain.

createdAt
string<date-time>
required
verifiedAt
string<date-time> | null
required