List Default Resource Configurations

Returns a paginated collection of default resource configurations for cloud-gateways, along with
organizationally-defined overrides for those resource configurations.
Resource configurations are settings that are applied to all cloud gateway resources in an organization.
For example, the “data-plane-group-idle-timeout-minutes” resource configuration sets the idle timeout for all data plane groups in an organization.

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

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

ListDefaultResourceConfigurationsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

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

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

List Resource Configurations

Returns a paginated collection of resource configurations for an organization.
Resource configurations are settings that are applied to all cloud gateway resources in an organization.
For example, the “data-plane-group-idle-timeout-minutes” resource configuration sets the idle timeout for all data plane groups in an organization.

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

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

ListResourceConfigurationsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about a resource configuration.

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

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-minutesauto-pilot-base-rps-max-value

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-minutesauto-pilot-base-rps-max-value

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

Get Resource Configuration

Retrieves a resource configuration by ID.

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

Path Parameters

resourceConfigurationIdstring(uuid)requiredread-only

The ID of the resource configuration to operate on.

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

Response

application/json

Response format for retrieving 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-minutesauto-pilot-base-rps-max-value

valueintegerrequired

The value of this resource configuration.

Example:45

get/cloud-gateways/resource-configurations/{resourceConfigurationId}
 
application/json

Update Resource Configuration

Updates a resource configuration by ID.

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

Path Parameters

resourceConfigurationIdstring(uuid)requiredread-only

The ID of the resource configuration to operate on.

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

Body

application/json

PatchResourceConfigurationRequest

Request schema for patching 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-minutesauto-pilot-base-rps-max-value

valueintegerrequired

The value of this resource configuration.

Example:45

Response

application/json

Response format for patching 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-minutesauto-pilot-base-rps-max-value

valueintegerrequired

The value of this resource configuration.

Example:45

patch/cloud-gateways/resource-configurations/{resourceConfigurationId}

Body

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