SnippetContent

string

The renderable markdown content of the snippet

Example

SnippetName

string

The name of the snippet (no leading slash)

Example

ListPortalPages

object

Tree of pages for the portal (nested children). Not paginated.

* Additional properties are NOT allowed.
dataarray[object]required

A single page for the portal

* Additional properties are NOT allowed.
Show Child Parameters
Example

ListPortalSnippets

object

A paginated list of snippets for the portal

* Additional properties are NOT allowed.
dataarray[object]

A single snippet for the portal

* Additional properties are NOT allowed.
Show Child Parameters
metaobject

returns the pagination information

Show Child Parameters
Example

PortalPageInfo

object

A single page for the portal

* Additional properties are NOT allowed.
idstring(uuid)required

The unique identifier of the page

Example:582b9327-3eba-4bfe-9438-6066840dbbca

slugstringrequired

The slug of the page.

Example:/my-page

titlestringrequired

The title of the page

Example:My Page

visibilitystringrequired

Whether the page or snippet is public or private. Private pages and snippets are only accessible to authenticated users.

Allowed values:publicprivate

Example:public

descriptionstring

Example:A custom page about developer portals

parent_page_idstring(uuid)required

Pages may be rendered as a tree of files.

created_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)requiredread-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

childrenarray[object]required

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":[]}

* Additional properties are NOT allowed.
Show Child Parameters
Example