New Docs

Hosts endpoints

Map and unmap custom domains.

On this page

Map a domain

curl -X PUT https://docs-service.example.com/v1/docs/$SITE_ID/hosts \
  -H "Content-Type: application/json" \
  -d '{"host": "docs.acme.com", "primary": true}'

Rules

  • Hosts are normalised to lowercase without a port.
  • A host can belong to only one site (409 otherwise).
  • Platform hostnames are refused with 422.

Unmap

curl -X DELETE https://docs-service.example.com/v1/docs/$SITE_ID/hosts/docs.acme.com

After mapping, point DNS at the server; the certificate follows automatically.

Last updated