Data-Plane Group Configurations

List Configurations

Returns a paginated collection of configurations across control-planes for an organization (restricted by
permitted control-plane reads).

get
https://global.api.konghq.com/v2/cloud-gateways/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

filterobject

Filters supported for configurations.

* Additional properties are NOT allowed.
Show Child Parameters

Response

application/json

A paginated list for a collection of configurations.

ListConfigurationsResponse

metaobjectrequired

returns the pagination information

Show Child Parameters
dataarray[object]required

Object containing information about a control-plane’s cloud-gateways configuration.

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

Create Configuration

Creates a new configuration for a control-plane (restricted by permitted control-plane permissions for
configurations). This request will replace any existing configuration for the requested control_plane_id and
control_plane_geo by performing a diff. From this diff, new resources detected in the requested configuration
will be added, resources not found in the request configuration but in the previous will be deleted, and
resources found in both will be updated to the requested configuration. Networks referenced in this request that
are in an offline state will automatically initialize (i.e. move to an initializing state).

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

Body

application/json

CreateConfigurationRequest

Request schema for creating a configuration.

* Additional properties are NOT allowed.
control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

versionstring

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

dataplane_groupsarray[object](set)required

Object that describes where to deploy a data-plane group, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

api_accessstring

Type of API access data-plane groups will support for a configuration.

Allowed values:privatepublicprivate+public

Default:private+public

Example:private+public

Response

application/json

Response format for creating a configuration.

Configuration

Object containing information about a control-plane’s cloud-gateways configuration.

idstring(uuid)requiredread-only

Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

versionstring

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

api_accessstring

Type of API access data-plane groups will support for a configuration.

Allowed values:privatepublicprivate+public

Default:private+public

Example:private+public

dataplane_group_configarray[object]required

Object that describes where a data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object](set)required

Object that describes the set of data-plane groups currently pointed to this configuration.

Show Child Parameters
kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration update date.

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

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

put/cloud-gateways/configurations

Body

{ "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388", "control_plane_geo": "us", "dataplane_groups": [ { "provider": "aws", "region": "us-east-2" } ] }
 
application/json

Get Configuration

Retrieves a configuration by ID (restricted by permitted control-plane read).

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

Path Parameters

configurationIdstring(uuid)requiredread-only

The ID of the configuration to operate on.

Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

Response

application/json

Response format for retrieving a configuration by ID.

Configuration

Object containing information about a control-plane’s cloud-gateways configuration.

idstring(uuid)requiredread-only

Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

versionstring

Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.

Example:3.2

api_accessstring

Type of API access data-plane groups will support for a configuration.

Allowed values:privatepublicprivate+public

Default:private+public

Example:private+public

dataplane_group_configarray[object]required

Object that describes where a data-plane group will be deployed to, along with how many instances.

* Additional properties are NOT allowed.
Show Child Parameters
dataplane_groupsarray[object](set)required

Object that describes the set of data-plane groups currently pointed to this configuration.

Show Child Parameters
kindstring

Pre-release Feature
This feature is currently in beta and is subject to change.

Kind of the Cloud Gateway deployment. If serverless.v1 is specified, the following fields
should be omitted (will be ignored if provided): autoscale, cloud_gateway_network_id, version.

Allowed values:dedicated.v0serverless.v1

Default:dedicated.v0

entity_versionnumberrequiredread-only

Positive, monotonically increasing version integer, to serialize configuration changes.

Example:1

created_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An RFC-3339 timestamp representation of configuration update date.

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

control_plane_idstring(uuid)required

Example:0949471e-b759-45ba-87ab-ee63fb781388

control_plane_geostringrequired

Set of control-plane geos supported for deploying cloud-gateways configurations.

Allowed values:useuaumeinsg

get/cloud-gateways/configurations/{configurationId}
 
application/json

Networks