Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Update metadata for a site.

Update the metadata for an existing site. A default site with ID 'default' exists out-of-the-box.

The update data must include the rev and name metadata fields. <br />User roles: admin, manager, editor

put/authoring/v1/sites/{site-id}

Path parameters

site-idstring uuid required

The ID of the site.

Query parameters

forceOverrideboolean

Force update of the existing site metadata without requiring the current rev value. When set to true this request will overwrite the stored site metadata regardless of a difference in revisions.

Headers

Content-Typestring required

Content type of the request body, should be 'application/json'

Request body

idstring

The ID of the site.

revstring

The current revision of the document. This is a required field.

namestring

The name of the site. This is a required field.

routingModestring

The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'. With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.

Response

Success, returns updated site

idstring

The ID of the site.

revstring

The current revision of the document.

namestring

The name of the site.

classificationstring

this is always site

routingModestring

The is the routing mode for the site, values are either 'anchor' or 'path'. The property controls the URL structure that is used to address individual pages within the site. With a routing mode of 'anchor' pages are addressed by URL anchors that are relative to the site root document, for example 'https://your.host/#/products'. With a routing mode of 'path' pages are addressed by URL path fragments instead of '#' anchors, for example 'https://your.host/products'. The 'path' mode is recommended for allowing external search crawlers to index the pages as separate documents.