SourceIPEnabled
booleanWhether ip allow list is enabled for the organization.
Default:false
Example:true
UnauthorizedError
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:401
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:Unauthorized
The error type.
Example:https://httpstatuses.com/401
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:Invalid credentials
ForbiddenError
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:403
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:Forbidden
The error type.
Example:https://httpstatuses.com/403
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:Forbidden
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