ListPortalSnippets
objectA paginated list of snippets for the portal
A single snippet for the portal
Show Child Parameters
returns the pagination information
Show Child Parameters
PortalPageInfo
objectA single page for the portal
The unique identifier of the page
Example:582b9327-3eba-4bfe-9438-6066840dbbca
The slug of the page.
Example:/my-page
The title of the page
Example:My Page
Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.
Allowed values:publicprivate
Example:public
Example:A custom page about developer portals
Pages may be rendered as a tree of files.
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
A single page for the portal
Example:{"id":"d32d905a-ed33-46a3-a093-d8f536af9a8a","slug":"hello-world","title":"Hello world","visibility":"public","parent_page_id":null,"children":[]}
Show Child Parameters
PortalSnippetInfo
objectA single snippet for the portal
The unique identifier of the snippet
Example:582b9327-3eba-4bfe-9438-6066840dbbcb
The name of the snippet (no leading slash)
Example:my-snippet
The title of the snippet
Example:My Snippet
Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.
Allowed values:publicprivate
Example:public
Example:A custom page about developer portals
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
PortalPage
objectA single page for the portal
The unique identifier of the page
Example:582b9327-3eba-4bfe-9438-6066840dbbca
The title of the page
Example:My Page
The slug of the page.
Example:/my-page
The renderable markdown content of the page
Example:# Welcome to the Developer Portal
Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.
Allowed values:publicprivate
Example:public
Example:A custom page about developer portals
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
Pages may be rendered as a tree of files.
ParentPageId
stringPages may be rendered as a tree of files.