Sign in
Data-Plane Group Configurations

Get Configuration

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

get/v2/cloud-gateways/configurations/{configurationId}

Path parameters

configurationIdstring uuid required
Example:edaf40f9-9fb0-4ffe-bb74-4e763a6bd471

The ID of the configuration to operate on.

Response

Response format for retrieving a configuration by ID.

idstring uuid required
versionstring

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

api_access'private' | 'public' | 'private+public'

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

kind'dedicated.v0' | 'serverless.v1'

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.

entity_versionnumber required

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

created_atstring date-time required

An RFC-3339 timestamp representation of configuration creation date.

updated_atstring date-time required

An RFC-3339 timestamp representation of configuration update date.

control_plane_idstring uuid required
control_plane_geo'us' | 'eu' | 'au' | 'me' | 'in' | 'sg' required

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

Example response

{
  "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  "version": "3.2",
  "api_access": "private+public",
  "dataplane_group_config": [
    {
      "provider": "aws",
      "region": "us-east-2",
      "cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
      "autoscale": {
        "requested_instances": 3
      },
      "environment": [
        {
          "name": "KONG_LOG_LEVEL",
          "value": "info"
        }
      ]
    }
  ],
  "dataplane_groups": [
    {
      "id": "cbb8872a-1f83-4806-bf69-fdf0b4783c7e",
      "provider": "aws",
      "region": "us-east-2",
      "autoscale": {
        "requested_instances": 3
      },
      "environment": [
        {
          "name": "KONG_LOG_LEVEL",
          "value": "info"
        }
      ],
      "cloud_gateway_network_id": "36ae63d3-efd1-4bec-b246-62aa5d3f5695",
      "state_metadata": {
        "reported_status": "ERROR",
        "reason": "Dataplane group could not be deployed due to insufficient cloud provider compute instances.\n"
      },
      "private_ip_addresses": [
        "192.168.248.132",
        "192.168.66.81",
        "192.168.137.135"
      ],
      "egress_ip_addresses": [
        "71.78.149.75",
        "91.149.112.244",
        "51.235.15.121"
      ],
      "created_at": "2022-11-04T20:10:06.927Z",
      "updated_at": "2022-11-04T20:10:06.927Z"
    }
  ],
  "entity_version": 1,
  "created_at": "2022-11-04T20:10:06.927Z",
  "updated_at": "2022-11-04T20:10:06.927Z",
  "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388"
}

Changes