Control Plane Resource Quotas

List Default Quotas

Returns a paginated collection of default resource quotas for control planes, along with
organizationally-defined overrides for those resource quotas.

get

Response

application/json

A response for listing default resource quota.

ListControlPlaneDefaultResourceQuotasResponse

dataarray[object]

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

Show Child Parameters
get/control-planes/default-resource-quotas
 
application/json

List Quota Overrides

Returns a list of control plane quota override values created by the user.

get

Response

application/json

A response for listing all resource quotas for control plane.

dataarray[object]
Show Child Parameters
get/control-planes/resource-quotas
 
application/json

Create a control plane resource quota

Creates a control plane resource quota scoped to a given resource, for an organization.

post

Body

application/json

Request body for creating the control plane override resource quota value.

Quota override for a control plane

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

Response

application/json

A response for creating the control plane resource quota value.

Quota override for a control plane

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

post/control-planes/resource-quotas

Body

{ "name": "consumer override", "description": "Increase for consumer resource quota", "resource": "count/control-plane.consumer", "value": 40000 }
 
application/json

Get Control Plane Resource Quota

Returns the control plane resource quota for the ID.

get

Path Parameters

resourceQuotaIdstring(uuid)required

The UUID for the control plane resource quota.

Example:7f9fd312-a987-4628-b4c5-bb4f4fddd5f7

Response

application/json

A response for getting the control plane resource quota value corresponding to resource or id.

Quota override for a control plane

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

get/control-planes/resource-quotas/{resourceQuotaId}
 
application/json