For the complete documentation index, see llms.txt. This page is also available as Markdown.

Site preview

Fetch an up-to-date preview of your site before publishing.

Quickly generate a preview of how your site's content and layout will appear once published, allowing for final checks and refinement prior to going live.

Available in MCP

Generate a temporary preview URL for a site's published content

get

Generates a time-limited URL (valid for 1 hour) to preview how a site will look when published. Use this to verify changes before making the site publicly accessible.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

organizationIdstringRequired

A unique entity identifier

Pattern: ^[a-zA-Z0-9_-]+$

siteIdstringRequired

The unique id of the site

Query parameters

siteSpacestringOptional

ID of the site-space to preview. If not provided, the default site-space will be used.

claimsstringOptional

Rison encoded string of attributes/assertions about the visitor for which we want to preview the site.

draftbooleanOptional

Whether to include draft content in the preview. Defaults to true

Default: true

targetstringOptional

Target URL of the preview. If not provided, the default site preview URL will be used.

Responses

200

application/json

urlstring · uri · max: 2048Required

400

Bad Request

application/json

get/orgs/{organizationId}/sites/{siteId}/publishing/preview

Last updated 1 day ago

Was this helpful?