NotFoundError

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.

Example:404

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.

Example:Not Found

typestringread-only

The error type.

Example:https://httpstatuses.com/404

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.

Example:kong:trace:1234567890

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

Example

Visibility

string

Allowed values:publicprivate

PortalMenuItem

object
* Additional properties are NOT allowed.
pathstringrequired

The absolute path of a page in a portal with a leading slash.

<= 512 characters

Example:/about/company

titlestringrequired

The link display text

Example:My Page

visibilitystringrequired

Whether a menu item is public or private. Private menu items are only accessible to authenticated users.

Allowed values:publicprivate

Example:public

externalbooleanrequired

When clicked, open the link in a new window

Example

PortalFooterMenuSection

object
* Additional properties are NOT allowed.
titlestringrequired

The footer menu section title

<= 512 characters

itemsarray[object]required
* Additional properties are NOT allowed.
Show Child Parameters
Example

PortalCustomization

object

The custom settings of this portal

* Additional properties are NOT allowed.
themeobject
* Additional properties are NOT allowed.
Show Child Parameters
layoutstring
cssstring
jsobject
* Additional properties are NOT allowed.
Show Child Parameters
menuobject
* Additional properties are NOT allowed.
Show Child Parameters
spec_rendererobject
* Additional properties are NOT allowed.
Show Child Parameters
robotsstring
Example