put/api/v1/docs-sites/{spaceId}/subdomain

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}/subdomain
  • Auth: none declared

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

subdomainstring required

Response

Subdomain saved. The live site moves to it with the next published build.

spaceIdinteger required
folderIdinteger required

The Space root folder's ID, for /nav and /folders.

namestring nullable required
subdomainstring required
urlstring required

Canonical live URL.

falconerSiteUrlstring required
customDomainstring nullable required
customDomainStatusstring required
isPublishedboolean required
isPasswordProtectedboolean required
publishedBuildIdstring nullable required
edgeOutcome'propagating' | 'confirmed' | 'unconfirmed' | 'failed' nullable required
canManageboolean required

Whether you can publish, roll back, or unpublish.

Changes

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