Get Configuration

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

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

Configurationobject

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

One Of
idstring(uuid)requiredread-only

ID of the configuration.

Example:f521675a-af6b-4684-be7b-43bc27b20543

kindstringrequired

Allowed values:dedicated.v0

control_plane_idstring(uuid)requiredread-only

ID of the control-plane a configuration belongs to.

Example:b5922611-a763-499e-8d86-5643de122768

control_plane_geostringrequired

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

Allowed values:useuaumeinsg

versionstringrequired

Gateway version the gateway configuration targets.

Match pattern:^(\d)+(\.(\d)+)?$

Example:3.2

api_accessstring

Type of API access dataplane groups will support for a configuration.

Allowed values:privateprivate+publicpublic

Default: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]required

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

Show Child Parameters
entity_versionnumberrequiredread-only

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

Example:1

created_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration creation date.

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

updated_atstring(date-time)requiredread-only

An ISO-8604 timestamp representation of configuration update date.

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

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

ConfigurationId

string
Example

Control-Plane Geo

string

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

Allowed values:useuaumeinsg

CloudGatewaysInstanceTypeName

string

Instance type name to indicate capacity.

Allowed values:smallmediumlarge

ServerlessV1ProviderName

string

Name of cloud provider.

Allowed values:aws

Example