LabelsUpdate
objectLabels store metadata of an entity that can be used for filtering an entity list or for searching across entity types.
Labels are intended to store INTERNAL metadata.
Keys must be of length 1-63 characters, and cannot start with “kong”, “konnect”, “mesh”, “kic”, or “_”.
ConflictError
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:409
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:Conflict
The error type.
Example:https://httpstatuses.com/409
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
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:Conflict
CursorPageParameters
objectThe number of items included per page.
Example:10
Cursor param specifying the page (i.e. the next page) of data returned.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
Cursor param specifying the page (i.e. the previous page) of data returned.
Example:ewogICJpZCI6ICJoZWxsbyB3b3JsZCIKfQ
StringFieldFilterExact
objectFilter using one of the following operators: eq, oeq, neq
The field exactly matches the provided value.
Example:?filter[field_name_here][eq]=foo
The field matches any of the provided values.
Example:?filter[field_name_here][oeq]=foo,bar
The field does not match the provided value.
Example:?filter[field_name_here][neq]=bar
CursorMetaPage
objectURI to the first page
URI to the last page
URI to the next page
URI to the previous page
Requested page size
Example:10