Skip to content

Domains

Custom domains are served through Cloudflare via a CNAME record. Apex domains are not supported — use a subdomain such as www.example.com.

GET /api/v1/projects/{id}/domains

Returns { domains } — each { id, name, project_id, is_verified, a_records, cname_records, status }.

await client.domains.list(projectId)
POST /api/v1/projects/{id}/domains

Body: name. Returns { domain } with 201. Point a CNAME record at the returned cname_records target, then verify.

Terminal window
curl -X POST "https://www.frontend.co/api/v1/projects/$ID/domains" \
-H "Authorization: Bearer $FRONTEND_API_KEY" \
-H "Content-Type: application/json" \
-d '{ "name": "www.example.com" }'
const domain = await client.domains.create(projectId, 'www.example.com')
console.log(domain.cname_records)
POST /api/v1/projects/{id}/domains/{domainId}/verify

Re-checks DNS and SSL status. Returns { domain, is_verified }.

await client.domains.verify(projectId, domain.id)
DELETE /api/v1/projects/{id}/domains/{domainId}

Returns { deleted }.

await client.domains.delete(projectId, domain.id)