Custom domains

Add a custom domain, bound to a site XOR a client space.

site_id keeps today’s behaviour (the hostname serves one page). space_id binds the hostname to a client space instead: the portal at /, member pages at /{space_path} — the client-spaces plan unit (Solo 1, Studio 10, Firm unlimited). Under a verified parent-domain claim the per-hostname TXT step is skipped and the response carries covered_by_claim.

post/custom-domains

Request

  • Base URL: https://api.stacktr.ee
  • URL: https://api.stacktr.ee/custom-domains
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://api.stacktr.ee/oauth/authorize, token URL https://api.stacktr.ee/oauth/token, scopes: sites:write, sites:read)

Request body

hostnamestring required
site_idstring nullable
space_idstring nullable

Mutually exclusive with site_id.

Response

Created.

hostnamestring required
site_idstring required
status'pending' | 'verified' | 'failed' required
cname_targetstring

CNAME value the user must add to their DNS.

verified_atinteger nullable

Example response

{
  "hostname": "docs.example.com"
}

Changes

No recorded changes to this operation across all 1 revision of this API.