CreatedAt

string

An ISO-8601 timestamp representation of entity creation date.

Example

UpdatedAt

string

An ISO-8601 timestamp representation of entity update date.

Example

ForbiddenError

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

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

typestringread-only

The error type.

Example:https://httpstatuses.com/403

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

Example

LegacyStringFieldFilter

object

Filter using one of the following operators: eq, contains

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

Example:?filter[field_name_here][eq]=foo

containsstring

The field contains the provided value.

Example:?filter[field_name_here][contains]=foo

Example

Labels

object

Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.

Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.

Example