Gateway
objectThe gateway object contains information about a Konnect gateway.
The gateway ID.
Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7
The name of the Gateway.
>= 1 characters<= 255 characters
A human-readable description of the Gateway.
<= 512 characters
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"}
An ISO-8604 timestamp representation of gateway creation date.
Example:2022-11-04T20:10:06.927Z
An ISO-8604 timestamp representation of gateway update date.
Example:2022-11-04T20:10:06.927Z
Error
objectstandard error
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.
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.
The error type.
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.
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.
InvalidRules
stringinvalid parameters rules
Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype
InvalidParameterStandard
objectExample:name
invalid parameters rules
Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype
Example:body
Example:is a required field
InvalidParameterMinimumLength
objectExample:name
invalid parameters rules
Allowed values:min_lengthmin_digitsmin_lowercasemin_uppercasemin_symbolsmin_itemsmin
Example:8
Example:body
Example:must have at least 8 characters