Docs sites
Manage your published docs sites.
The Docs Sites API lets you programmatically manage published documentation sites within your organization. You can list and update all sites created under a specific organization, making it easy to audit or interact with site metadata at scale.
Unique identifier of the site
The type of the site
The currently applied type of the site. For example, frozen sites will have this set to Basic.
Title of the site
Custom hostname for the site, for e.g. docs.mycompany.com
^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$Basename for the site. For e.g. api
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
Permissions resolution mode for the site.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Whether the site is live or not. If true, the site is accessible to the audience defined by the visibility setting.
The Site object
Returns a paginated list of all documentation sites belonging to the organization. Use this to discover available sites before fetching their content, settings, or structure.
A unique entity identifier
^[a-zA-Z0-9_-]+$Identifier of the page results to fetch.
The number of results per page
Identifier of the space to filter the sites by
Filter sites by their title
Filter sites by their published status
OK
Total count of objects in the list
OK
Creates a new documentation site within the organization. Optionally links one or more existing spaces as content sources at creation time. The site is created in an unpublished state; call the publish endpoint separately to make it publicly accessible.
A unique entity identifier
^[a-zA-Z0-9_-]+$The type of the site, defaults to Basic
Title of the site
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
ID of spaces to be added to the site
Site created
Site created
Retrieves full details for a single documentation site. Use this to inspect a specific site's metadata before reading or modifying its settings, structure, or content.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
OK
Unique identifier of the site
The type of the site
The currently applied type of the site. For example, frozen sites will have this set to Basic.
Title of the site
Custom hostname for the site, for e.g. docs.mycompany.com
^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$Basename for the site. For e.g. api
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
Permissions resolution mode for the site.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Whether the site is live or not. If true, the site is accessible to the audience defined by the visibility setting.
No matching site found
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Site did not exist
Site has been deleted
No content
Updates a documentation site's configuration. Use this to rename a site, change its access level, or point it at a reverse-proxy path such as https://company.com/docs.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Title of the site
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
Basename for the site. For e.g. api
Permissions resolution mode for the site.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
ID of the site-space to be used as the default at the root level. If site has sections, this will mark the default site space in the site's default section.
ID of the site-section to be used as the default.
Configure a proxy URL for a site. For example, you can use it to host the site on a subdirectory of your domain like https://company.com/docs.
Use null to remove the proxy.
Proxy URL for the site, for e.g. company.com/docs or www.company.com/developer/docs etc.
^([\w-]+\.)*[\w-]+\.[a-zA-Z]{2,}(\/[\w-]+)+$Attach an existing styleguide to the site by the ID of the styleguide space, or null to detach the current one. The space must be a styleguide owned by the same organization.
OK
Unique identifier of the site
The type of the site
The currently applied type of the site. For example, frozen sites will have this set to Basic.
Title of the site
Custom hostname for the site, for e.g. docs.mycompany.com
^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$Basename for the site. For e.g. api
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
Permissions resolution mode for the site.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Whether the site is live or not. If true, the site is accessible to the audience defined by the visibility setting.
OK
Returns the JSON schema that defines the visitor attributes expected by an adaptive content site. Adaptive content uses these attributes (e.g., user role, plan tier) to conditionally show or hide content sections. Use this to understand what visitor data must be provided when rendering adaptive content.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
The JSON schema that defines the attributes expected from a visitor of the Adaptive content site.
When the adaptive schema was updated.
No visitor attributes schema found for the site.
Unexpected Error
Replaces the JSON schema that defines expected visitor attributes for adaptive content. The schema controls which attributes (e.g., role, subscription tier) can be used in conditional expressions to show or hide content for specific visitors. After updating, existing conditional expressions are evaluated against the new schema.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
The site adaptive schema has been updated.
When the adaptive schema was updated.
Bad Request
Unexpected Error
Returns pre-generated condition templates derived from the site's visitor attributes schema. These templates can be used as building blocks when writing adaptive content expressions to conditionally show or hide content for different visitor types. Use this to discover available conditions before authoring adaptive rules.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
List of template conditions generated based on the site visitor schema.
List of template conditions generated based on the site visitor schema.
Returns the complete profile needed to render the published experience of a site. Use this when building a site renderer or preview rather than fetching each resource individually.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
For sites published via share-links, the share key is useful to resolve published URLs.
OK
No matching site found
Makes the site publicly accessible at its configured URL by publishing it. If the organization's plan requires an upgrade, the response includes a Stripe checkout session ID instead of the site object. Use unpublish to take the site offline again.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Site published successfully
Site published successfully
Removes the site from public access by unpublishing it. The site's configuration and content are preserved; use the publish endpoint to make it accessible again. Use this when you need to temporarily hide a site or take it down for maintenance.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Site unpublished successfully
Unique identifier of the site
The type of the site
The currently applied type of the site. For example, frozen sites will have this set to Basic.
Title of the site
Custom hostname for the site, for e.g. docs.mycompany.com
^([a-z0-9]([a-z0-9-]{0,61}[a-z0-9])?[.]){2,}[a-z0-9][a-z0-9-]{0,61}[a-z0-9]$Basename for the site. For e.g. api
The visibility setting of the site determines the audience of the site.
public: Anyone can access the site, and the site is indexed by search engines.unlisted: Anyone can access the site, and the site is not indexed by search enginesshare-link: Anyone with a secret token in the url can access the site.visitor-auth: Anyone authenticated through a JWT token can access the site.
Permissions resolution mode for the site.
Default level for a piece of content
"The role of a member in an organization. "admin": Can administrate the content: create, delete spaces, ... "create": Can create content. "review": Can review content. "edit": Can edit the content (live or change requests). "comment": Can access the content and its discussions. "read": Can access the content, but cannot update it in any way.
Whether the site is live or not. If true, the site is accessible to the audience defined by the visibility setting.
Site unpublished successfully
Reorders an item in the site's navigation structure by moving a site space, section, or section group to a specified position relative to another item. Use this to reorganize the navigation order after adding new sections or to reflect a new content hierarchy.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Item successfully moved
A site structure item can be a site space, a site section or a site section group. It is used to represent the structure of a site.
Invalid move position provided
No matching item found
Unexpected Error
Performs a full-text search across all published spaces in the site and returns matching pages with relevant excerpts. Use the scope parameter to restrict the search to specific site spaces or sections. Prefer this over the space-level search when you need to search across a multi-section site in one call.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Identifier of the page results to fetch.
The number of results per page
OK
Total count of objects in the list
OK
Ensures the site has a dedicated styleguide space and returns a reference to it. The styleguide defines writing style and tone guidelines that the AI editor agent references when generating or refining content for the site. If a styleguide already exists, this is idempotent and returns the existing reference.
A unique entity identifier
^[a-zA-Z0-9_-]+$The unique id of the site
Built-in template id to seed the styleguide content with. Omit (or send no body) to create a blank styleguide.
Styleguide created or already exists.
Not Found
Last updated
Was this helpful?