LabelsUpdate

object

Labels 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 “_”.

Example

ConflictError

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

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

typestringread-only

The error type.

Example:https://httpstatuses.com/409

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

Example

DateTimeFieldFilter

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

One Of
Example

UUID_RW

string

Contains a unique identifier used for this resource.

Example

AuthStrategyKeyAuth

object

KeyAuth Auth strategy that the application uses.

* Additional properties are NOT allowed.
idstring(uuid)requiredread-only

The Application Auth Strategy ID.

Example:b9e81174-b5bb-4638-a3c3-8afe61a0abf8

namestringrequired

Default:name

Example:name

credential_typestringrequired

Allowed values:key_auth

key_namesarray[string]required
ttlobject

Default maximum Time-To-Live for keys created under this strategy.

Show Child Parameters
Example