ParentPageId

string

Pages may be rendered as a tree of files.

PortalSnippet

object

A single snippet for the portal

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

The unique identifier of the page

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

titlestringrequired

The title of the snippet

Example:My Snippet

namestringrequired

The name of the snippet (no leading slash)

Example:my-snippet

contentstringrequired

The renderable markdown content of the snippet

Example:# Welcome to the Developer Portal

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

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

CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

Example

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

Example

Error

object

standard error

statusintegerrequiredread-only

The HTTP status code of the error. Useful when passing the response
body to child properties in a frontend UI. Must be returned as an integer.

titlestringrequiredread-only

A short, human-readable summary of the problem. It should not
change between occurences of a problem, except for localization.
Should be provided as “Sentence case” for direct use in the UI.

typestringread-only

The error type.

instancestringrequiredread-only

Used to return the correlation ID back to the user, in the format
kong:trace:<correlation_id>. This helps us find the relevant logs
when a customer reports an issue.

detailstringrequiredread-only

A human readable explanation specific to this occurence of the problem.
This field may contain request/entity data to help the user understand
what went wrong. Enclose variable values in square brackets. Should be
provided as “Sentence case” for direct use in the UI.

Example