PageVisibilityStatus
stringWhether 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
PageVisibilityStatus
stringWhether 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
UpdatePortalPageRequest
objectUpdate a page in a portal.
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
Whether the resource is publicly accessible to non-authenticated users.
Allowed values:publicprivate
Example:public
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
Example:A custom page about developer portals
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.
CreatePortalPageRequest
objectCreate a page in a portal.
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
The title of a page in a portal.
<= 512 characters
Example:My Page
The renderable markdown content of a page in a portal.
<= 1000000 characters
Example:# Welcome to My Page
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
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
Example:A custom page about developer portals
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.
PortalPageInfo
objectInformation about a page in a portal.
Contains a unique identifier used for this resource.
Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7
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
The title of a page in a portal.
<= 512 characters
Example:My Page
Whether the resource is publicly accessible to non-authenticated users.
Allowed values:publicprivate
Example:public
Whether the resource is visible on a given portal. Defaults to unpublished.
Allowed values:publishedunpublished
Example:published
<= 160 characters
Example:A custom page about developer portals
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.
Information about a page in a portal.
Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","slug":"hello-world","title":"Hello world","visibility":"public","created_at":"2023-01-11T02:30:42.227Z","updated_at":"2023-01-11T02:30:42.227Z","status":"unpublished","parent_page_id":null,"children":[]}
Show Child Parameters
An ISO-8601 timestamp representation of entity creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8601 timestamp representation of entity update date.
Example:2022-11-04T20:10:06.927Z