put/api/v1/docs-sites/{spaceId}/custom-domain

Request

  • Base URL: https://falconer.com (the document declares no server; this is the origin it was published from)
  • URL: https://falconer.com/api/v1/docs-sites/{spaceId}/custom-domain
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

domainstring required

A host such as docs.example.com, or a host and path such as example.com/docs that your own proxy forwards to the site.

Response

The domain, pending until its DNS checks out.

customDomainstring nullable required
mode'host' | 'path' nullable required

host: point a CNAME at cnameTarget. path: proxy the path to proxyTarget yourself.

status'none' | 'pending' | 'ready' | 'active' | 'suspended' | 'removing' | 'failed' required
cnameTargetstring required
edgeSettlingboolean required

The live site is still moving to its new address.

addonsPendingboolean required

An enable or disable is still being applied.

Changes

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