ResourceDescription

string

<= 160 characters

Example

PageVisibilityStatus

string

Whether a page is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.

Allowed values:publicprivate

Example

PageVisibilityStatus

string

Whether a snippet is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.

Allowed values:publicprivate

Example

UpdatePortalPageRequest

object

Update a page in a portal.

* Additional properties are NOT allowed.
slugstring

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether the resource is publicly accessible to non-authenticated users.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example

CreatePortalPageRequest

object

Create a page in a portal.

* Additional properties are NOT allowed.
slugstringrequired

The slug of a page in a portal, used to compute its full URL path within the portal hierarchy.
When a page has a parent_page_id, its full path is built by joining the parent’s slug with its own.
For example, if a parent page has the slug slug1 and this page’s slug is slug2, the resulting path will be /slug1/slug2.
This enables nested page structures like /slug1/slug2/slug3.

<= 512 characters

Example:/my-page

titlestring

The title of a page in a portal.

<= 512 characters

Example:My Page

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Page

visibilitystring

Whether a page is publicly accessible to non-authenticated users.
If not provided, the default_page_visibility value of the portal will be used.

Allowed values:publicprivate

Example:public

statusstring

Whether the resource is visible on a given portal. Defaults to unpublished.

Allowed values:publishedunpublished

Example:published

descriptionstring

<= 160 characters

Example:A custom page about developer portals

parent_page_idstring(uuid)

Pages may be rendered as a tree of files.

Specify the id of another page as the parent_page_id to add some hierarchy to your pages.

Example