Custom domains

Bring-your-own domains after DNS verification.

DELETE /custom-domains

Delete custom domain

Soft-deletes a custom domain and deactivates links on it.

Behaviour

Re-register via `POST /custom-domains` (new verification token).

Request body (JSON)

Responses

GET /custom-domains

Custom domain list

Returns custom domains for the account (or API key scope).

Behaviour

With `scope_id`, quota and access follow the scope billing owner. Field `limit` — custom-domain quota for the plan.

Query parameters

Responses

POST /custom-domains

Register custom domain

Registers a custom domain (FQDN) in the scope and returns DNS instructions for verification.

Behaviour

Next: add TXT and CNAME at the registrar, then call `POST /custom-domains/verify`.

Request body (JSON)

Responses

POST /custom-domains/verify

Verify custom domain DNS

Checks DNS records for a registered custom domain (TXT — ownership, CNAME — routing).

Behaviour

Order: add TXT and CNAME at the registrar first, then call this endpoint.

Request body (JSON)

Responses

API — all sections · Documentation