authoring-list-sites
List Sitecore sites via the Authoring and Management API to get each site's root path, start path, and root item ID for scoping subtree searches. Use includeSystemSites to show internal sites.
Instructions
Lists the sites configured on the Sitecore instance over the Authoring and Management API, with each site's root path, start path and root item ID. Usually the first call when working on an instance you have not seen: the root item ID is what authoring-search scopes a subtree search by, and the root path is what item paths hang off. System sites (shell, admin, login and the rest) are hidden unless includeSystemSites is set.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| includeSystemSites | No | When true, also return Sitecore's own internal sites (shell, login, admin, service). Off by default. |