Domains API

Custom domains and SSL provisioning

REST API endpoints for Domains. 6 operations.

List custom domains

GET /v1/domains

Returns all custom domains attached to the caller's project, with their verification and SSL status.

Auth: Bearer API key

Responses

operationId: listDomains

Add a custom domain

POST /v1/domains

Registers a custom domain for the caller's project and returns the created record plus the DNS records (CNAME + TXT) needed to verify and serve it.

Auth: Bearer API key

Request body

application/json (required) — schema AddDomainBody.

Responses

operationId: addDomain

Remove a custom domain

DELETE /v1/domains/{id}

Detaches a custom domain from the caller's project and deletes its record.

Auth: Bearer API key

Parameters

Responses

operationId: deleteDomain

Get a custom domain

GET /v1/domains/{id}

Returns a single custom domain by id, scoped to the caller's project.

Auth: Bearer API key

Parameters

Responses

operationId: getDomain

Provision SSL for a domain

POST /v1/domains/{id}/ssl

Starts background Let's Encrypt certificate issuance for a verified domain. The domain must be active; automatic SSL must be configured on the deployment.

Auth: Bearer API key

Parameters

Responses

operationId: provisionDomainSsl

Verify a custom domain

POST /v1/domains/{id}/verify

Confirms — via a standard public DNS lookup, no provider credentials — that the customer's domain points at our edge (its A records match cname.<platform>, or a configured SCALIX_EDGE_IP). On success, marks the domain active. This is the industry-standard "does it point at us" check (Vercel/Netlify/Render).

Auth: Bearer API key

Parameters

Responses

operationId: verifyDomain