Sign in

v1

latestOpenAPI 3.0.02026-07-2417611.8 MB
Authoring sites

Retrieve metadata for a site.

Retrieve the site metadata for an existing site. A default site with ID 'default' exists out-of-the-box. <br />User roles: admin, manager, editor, viewer

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

Path parameters

site-idstring uuid required

The ID of the site.

Query parameters

fieldsstring

Optional. Only the site metadata fields that are specified here are returned for each result. Any site metadata field is a valid value and can be specified as a comma-separated list. Field names should only be specified once in the list.

For example, to only retrieve name and rev this parameter should look like fields=name,rev.

Response

Success

idstring

The ID of the site.

revstring

The current revision of the document.

namestring

The name of the site.

classificationstring

This is always site

lastModifiedstring

The last modified date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only.

lastModifierIdstring

This is the user id of the user that modified the site metadata. This field is read only

createdstring

The creation date of this site metadata in ISO 8601 with the format YYYY-MM-DDTHH:mm:ss.sssZ. This field is read only

creatorIdstring

This is the user id of the user that created the site metadata. This field is read only.

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.