Create a new documentation site in an organization
post
Authorizations
AuthorizationstringRequired
Bearer authentication header of the form Bearer <token>.
Path parameters
organizationIdstringRequiredPattern:
A unique entity identifier
^[a-zA-Z0-9_-]+$Body
typestring · enumOptionalPossible values:
The type of the site. Defaults to:
- Sponsored for community organizations
- Ultimate for all other organizations
titlestring · min: 2 · max: 128Optional
Title of the site
visibilitystring · enumOptionalPossible values:
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.
spacesstring[]Optional
ID of spaces to be added to the site
Responses
201
Site created
application/json
post/orgs/{organizationId}/sites
201
Site created
Last updated
Was this helpful?