Konnect Control Planes

PaginatedMeta

object

returns the pagination information

pageobjectrequired

Contains pagination query parameters and the total number of objects returned.

Show Child Parameters
Example

Error

object

standard error

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.

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.

typestringread-only

The error type.

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.

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

InvalidRules

string

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertyis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_region

InvalidParameterStandard

object
* Additional properties are NOT allowed.
fieldstringrequiredread-only

Example:name

rulestringread-only

invalid parameters rules

Allowed values:requiredis_arrayis_base64is_booleanis_date_timeis_integeris_nullis_numberis_objectis_stringis_uuidis_fqdnis_arnunknown_propertyis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_region

sourcestring

Example:body

reasonstringrequiredread-only

Example:is a required field

Example

InvalidParameterMinimumLength

object
* Additional properties are NOT allowed.
fieldstringrequiredread-only

Example:name

rulestringrequiredread-only

invalid parameters rules

Allowed values:min_lengthmin_digitsmin_lowercasemin_uppercasemin_symbolsmin_itemsmin

minimumintegerrequired

Example:8

sourcestring

Example:body

reasonstringrequiredread-only

Example:must have at least 8 characters

Example