PatchControlPlaneResourceQuota

object

Request schema for patching a resource quota for an organization.

* Additional properties are NOT allowed.
valueintegerrequired

The aggregate non-negative integer count of this resource that’s allowed for the organization.

>= 1

Example:5000

Example

Quota override for a control plane

object
idstring(uuid)read-only

The unique identifier for the resource quota.

namestring

The human-readable name of this resource quota.

Example:Consumer

descriptionstring

A more verbose description of what this resource quota enforces.

Example:Across the organization, the aggregate number of consumers cannot exceed this value.

resourcestringrequired

Identifier value of resources available for quota enforcement.

Example:count/consumer

valueintegerrequired

The aggregate non-negative integer count of this resource that’s allowed for the organization.

>= 1

Example:5000

created_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity creation date.

Example:2022-11-04T20:10:06.927Z

updated_atstring(date-time)read-only

An ISO-8601 timestamp representation of entity update date.

Example:2022-11-04T20:10:06.927Z

Example

Default Resource Quota

object

Object containing information about a default resource quota, and any organizational overrides.

idstringrequiredread-only

The unique identifier for the default quota.

namestringrequired

The human-readable name of this resource quota.

Example:Consumer

descriptionstringrequired

A more verbose description of what this resource quota enforces.

Example:Across the organization, the aggregate number of consumers cannot exceed this value.

resourcestringrequired

The resource name under a control plane.

valueintegerrequired

The resource quota value for the corresponding resource.

overridesarray[object]

Organizational overrides for this default resource quota.

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_propertymissing_referenceis_labelmatches_regexinvalidis_supported_network_availability_zone_listis_supported_network_cidr_blockis_supported_provider_regiontype