List Default Resource Quotas

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

get
https://global.api.konghq.com/v2/cloud-gateways/default-resource-quotas

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list for a collection of default resource quotas.

ListDefaultResourceQuotasResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

Show Child Parameters
get/cloud-gateways/default-resource-quotas
 
application/json

List Resource Quotas

Returns a paginated collection of resource quotas for an organization.

get
https://global.api.konghq.com/v2/cloud-gateways/resource-quotas

Query Parameters

page[size]integer

The maximum number of items to include per page. The last page of a collection may include fewer items.

Example:10

page[number]integer

Determines which page of the entities to retrieve.

Example:1

Response

application/json

A paginated list for a collection of resource quotas.

ListResourceQuotasResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about a resource quota for an organization.

Show Child Parameters
get/cloud-gateways/resource-quotas
 
application/json

Create Resource Quota

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

post
https://global.api.konghq.com/v2/cloud-gateways/resource-quotas

Body

application/json

CreateResourceQuotaRequest

Request schema for creating a resource quota for an organization.

* Additional properties are NOT allowed.
resourcestringrequired

Enumeration of resources available for quota enforcement.

Allowed values:count/provider-accounts.per-providercount/networks.not-offlinecount/data-planes-estimatecount/serverless-data-planes-estimatecount/data-plane-groups-estimate

valueintegerrequired

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

>= 0

Example:2

Response

application/json

Response format for creating a resource quota for an organization.

Resource Quota

Object containing information about a resource quota for an organization.

idstring(uuid)requiredread-only

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

resourcestringrequired

Enumeration of resources available for quota enforcement.

Allowed values:count/provider-accounts.per-providercount/networks.not-offlinecount/data-planes-estimatecount/serverless-data-planes-estimatecount/data-plane-groups-estimate

namestringrequiredread-only

The human-readable name of this resource quota.

Example:Active Networks

descriptionstringrequiredread-only

A more verbose description of what this resource quota enforces.

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

valueintegerrequired

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

>= 0

Example:2

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota update date.

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

post/cloud-gateways/resource-quotas

Body

{ "resource": "count/provider-accounts.per-provider", "value": 2 }
 
application/json

Get Resource Quota

Retrieves a resource quota by ID.

get
https://global.api.konghq.com/v2/cloud-gateways/resource-quotas/{resourceQuotaId}

Path Parameters

resourceQuotaIdstring(uuid)requiredread-only

The ID of the resource quota to operate on.

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

Response

application/json

Response format for retrieving a resource quota for an organization.

Resource Quota

Object containing information about a resource quota for an organization.

idstring(uuid)requiredread-only

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

resourcestringrequired

Enumeration of resources available for quota enforcement.

Allowed values:count/provider-accounts.per-providercount/networks.not-offlinecount/data-planes-estimatecount/serverless-data-planes-estimatecount/data-plane-groups-estimate

namestringrequiredread-only

The human-readable name of this resource quota.

Example:Active Networks

descriptionstringrequiredread-only

A more verbose description of what this resource quota enforces.

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

valueintegerrequired

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

>= 0

Example:2

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota update date.

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

get/cloud-gateways/resource-quotas/{resourceQuotaId}
 
application/json

Update Resource Quota

Updates a resource quota by ID.

patch
https://global.api.konghq.com/v2/cloud-gateways/resource-quotas/{resourceQuotaId}

Path Parameters

resourceQuotaIdstring(uuid)requiredread-only

The ID of the resource quota to operate on.

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

Body

application/json

PatchResourceQuotaRequest

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.

>= 0

Example:2

Response

application/json

Response format for patching a resource quota for an organization.

Resource Quota

Object containing information about a resource quota for an organization.

idstring(uuid)requiredread-only

Example:9678f205-49a1-47bb-82d9-d01cafa42a0d

resourcestringrequired

Enumeration of resources available for quota enforcement.

Allowed values:count/provider-accounts.per-providercount/networks.not-offlinecount/data-planes-estimatecount/serverless-data-planes-estimatecount/data-plane-groups-estimate

namestringrequiredread-only

The human-readable name of this resource quota.

Example:Active Networks

descriptionstringrequiredread-only

A more verbose description of what this resource quota enforces.

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

valueintegerrequired

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

>= 0

Example:2

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of resource quota update date.

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

patch/cloud-gateways/resource-quotas/{resourceQuotaId}

Body

{ "value": 2 }
 
application/json