post/api/v1/docs-sites/{spaceId}/builds

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

Path parameters

spaceIdinteger required

Space id, from GET /spaces.

Headers

x-organization-idstring

Required when using OAuth bearer tokens.

Request body

autoPublishboolean

Publish as soon as the build succeeds. Requires public docs management.

Response

Release build queued, or the matching build already in the queue.

idstring required
buildNumberinteger nullable required
status'queued' | 'building' | 'succeeded' | 'failed' required
indexStatus'pending' | 'indexing' | 'ready' | 'failed' required

Search indexing of the build; meaningful once status is succeeded.

errorstring nullable required
indexErrorstring nullable required
autoPublishboolean required
isPublishedboolean required

Whether this build is the one the live site serves.

staleSubdomainboolean required

Built before the site was renamed, so its canonical URLs and sitemap point at the old host. Publishing it serves stale URLs until a rebuild.

createdAtstring required
completedAtstring nullable required
publicUrlstring required
edgeOutcome'propagating' | 'confirmed' | 'unconfirmed' | 'failed' nullable required

Publish propagation state; set only on the build the site points at.

edgeErrorstring nullable required

Changes

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