Adds a CNAME (Canonical Name) record to the domain’s DNS zone, aliasing one hostname to another.
Use case: Alias a subdomain to another hostname — for example, point www.example.com → example.com, or point shop.example.com → a third-party platform’s domain.
host: The subdomain label being aliased (relative to the zone). Use a label like www or shop. CNAME records cannot be set on the apex domain (@) — use an A record for that.
value: The target hostname the alias should resolve to (fully qualified, e.g. target.example.com).
TTL: Controls how long resolvers cache the record. Minimum is 300 seconds (5 minutes). Omit to use the zone default.
Prerequisite: DNS service must be activated for the domain via POST /api/v1/dns/activate before records can be added.
A personal access token. Obtain one from the dashboard under Settings > API Key. Include it in the Authorization header as Bearer <token>. Unauthenticated requests to protected routes return 401 Unauthorized.
Order ID of the domain.
124680932
Target hostname this alias should resolve to (fully qualified domain name).
"target.example.com"
Subdomain label being aliased, relative to the zone (e.g. www, shop). Cannot be @ — CNAME is not allowed at the apex.
"www"
TTL in seconds. Minimum 300. Omit to use the zone default.
300