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
MinRuntimeVersionUpdate
stringThe minimum runtime version supported by the API. This is the lowest version of the data plane
release that can be used with the entity model.
When not specified, the minimum runtime version will not be updated.
Match pattern:^\d+\.\d+$
UpdateGatewayRequest
objectThe request schema for the update gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
The minimum runtime version supported by the API. This is the lowest version of the data plane
release that can be used with the entity model.
When not specified, the minimum runtime version will not be updated.
Match pattern:^\d+\.\d+$
Example:1.1
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:{"env":"test"}
PatchGatewayRequest
objectThe request schema for the patch gateway request.
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
The minimum runtime version supported by the API. This is the lowest version of the data plane
release that can be used with the entity model.
When not specified, the minimum runtime version will not be updated.
Match pattern:^\d+\.\d+$
Example:1.1
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:{"env":"test"}
StringFieldEqualsFilter
Filters on the given string field value by exact match.