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

DateTimeFieldFilter

Filters on the given datetime (RFC-3339) field value.

One Of
Example

StringFieldFilterExact

object

Filter using one of the following operators: eq, oeq, neq

* Additional properties are NOT allowed.
eqstring

The field exactly matches the provided value.

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

oeqstring

The field matches any of the provided values.

Example:?filter[field_name_here][oeq]=foo,bar

neqstring

The field does not match the provided value.

Example:?filter[field_name_here][neq]=bar

Example

BooleanFieldFilter

boolean

Filter by a boolean value (true/false).

CursorMetaPage

object
firststring(path)

URI to the first page

laststring(path)

URI to the last page

nextstring(path)required

URI to the next page

previousstring(path)required

URI to the previous page

sizenumberrequired

Requested page size

Example:10

Example