Cloud Gateways Resource Quotas

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-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-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

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-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

Resource Configurations

Create Resource Configuration

Creates a new resource configuration for an organization.

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

Body

application/json

CreateResourceConfigurationRequest

Request schema for creating a resource configuration for an organization.

* Additional properties are NOT allowed.
qualifierstringrequired

Enumeration of configuration qualifiers available for organization-wide configuration.

Allowed values:data-plane-group-idle-timeout-minutes

valueintegerrequired

The value of this resource configuration.

Example:45

Response

application/json

Response format for creating a resource configuration for an organization.

Resource Configuration

Object containing information about a resource configuration.

idstring(uuid)requiredread-only

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

qualifierstringrequired

Enumeration of configuration qualifiers available for organization-wide configuration.

Allowed values:data-plane-group-idle-timeout-minutes

valueintegerrequired

The value of this resource configuration.

Example:45

post/cloud-gateways/resource-configurations

Body

{ "qualifier": "data-plane-group-idle-timeout-minutes", "value": 45 }
 
application/json