Organization State

object
idstring(uuid)read-only

UUID of the organization.

Example:d99c041a-c7cf-46a2-bf3a-44bb5f75400e

statestring

State of the organization.

Allowed values:activeinactivedeletingdeleted

Example:active

reasonstring

The reason for the organization’s state.

Example:invoice overdue (30 days)

servicestring

The service that modified the state.

Example:kbilling

changed_bystring

The ID of the Konger who modified the state.

Example:00uerwcs8eC4ifanR256

created_atstring(date-time)read-only

Date the organization state was created.

Example:2023-01-23T17:22:52.150Z

Example

Deletion Config

object
retention_period_daysinteger

The retention period in days.

>= 1<= 365

Example:90

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_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

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_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype

sourcestring

Example:body

reasonstringrequiredread-only

Example:is a required field

Example