ListPortalPagesResponse

object

Tree of custom pages in a portal. Not paginated.

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

Information about a page in a portal.

* Additional properties are NOT allowed.
Show Child Parameters
Example

PortalSnippetResponse

object

Details about a snippet in a portal.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

Contains a unique identifier used for this resource.

Example:5f9fd312-a987-4628-b4c5-bb4f4fddd5f7

namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystringrequired

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

Allowed values:publicprivate

Example:public

statusstringrequired

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

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

Example

ListPortalSnippetsResponse

object

A paginated list of custom snippets in a portal.

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

Information about a snippet in a portal.

* Additional properties are NOT allowed.
Show Child Parameters
metaobjectrequired

returns the pagination information

Show Child Parameters
Example

UpdatePortalSnippetRequest

object

Update a snippet in a portal.

* Additional properties are NOT allowed.
namestring

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstring

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

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

Example

CreatePortalSnippetRequest

object

Create a snippet in a portal.

* Additional properties are NOT allowed.
namestringrequired

The unique name of a snippet in a portal.

<= 512 characters

Example:my-snippet

titlestring

The display title of a snippet in a portal.

<= 512 characters

Example:My Snippet

contentstringrequired

The renderable markdown content of a page in a portal.

<= 1000000 characters

Example:# Welcome to My Snippet

visibilitystring

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: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

Example