Skip to main content
POST
Add domain

Authorizations

X-API-Key
string
header
required

API key with format cs_live_xxx

Body

application/json

Request schema for adding a new domain.

domain
string
required

Domain name to add (e.g., example.com)

Required string length: 3 - 255
workspace_id
string<uuid> | null

Workspace to assign the domain to. Required for internal API; resolved automatically from API key for public API.

Response

Domain added successfully

Response for domain addition.

domain_id
string<uuid>
required

Domain ID

domain_name
string
required

Domain name

status
string
required

Domain status

nameservers
string[]
required

Nameservers to configure at your registrar

dns_records
Dns Records · object
required

DNS records information

dns_check_url
string
required

URL to check DNS status

next_step_url
string
required

URL for next step (activation)

success
boolean
default:true
message
string
default:Domain added successfully