Sign in
Data-Plane Group Configurations

Get Configuration

Retrieves a single Cloud Gateway configuration by ID, including the current state of each deployed data plane group. Access is restricted to control planes the caller has permission to 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'

Controls how data planes in a configuration are exposed. Supported values:

  • private — data planes are accessible only within the VPC network; no public internet exposure
  • public — data planes are accessible from the public internet
  • private+public — equivalent to public; data planes are accessible from the public internet (default)
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

ID of the Konnect control plane. Can be retrieved from the Control Planes API or the Konnect UI.

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

Geographic region of the control plane. Supported values:

  • us — United States
  • eu — Europe
  • au — Australia
  • me — Middle East
  • in — India
  • sg — Singapore

Example response

{
  "id": "edaf40f9-9fb0-4ffe-bb74-4e763a6bd471",
  "version": "3.10",
  "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

Changed in 11 of the 75 revisions of this API.2139

  • a2e95e9f6c801See the full diff
    • ○

      added the optional property dataplane_groups/items/hostnames to the response with the 200 status

      response-optional-property-added

    This revision also has 23 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • c83332d134eb4See the full diff
    • ▲

      the dataplane_group_config/items/environment/items/value response property's maxLength was increased from 120 to 2048 for the response status 200

      response-property-max-length-increased

    • ▲

      the dataplane_groups/items/environment/items/value response property's maxLength was increased from 120 to 2048 for the response status 200

      response-property-max-length-increased

    • ▲

      the dataplane_group_config/items/environment/items/name response's property type/format changed from string/^KONG_[a-zA-Z_]+[a-zA-Z0-9_]* to string/^(KONG|OTEL)_[a-zA-Z_]+[a-zA-Z0-9_]* for status 200

      response-property-type-changed

    • ▲

      the dataplane_groups/items/environment/items/name response's property type/format changed from string/^KONG_[a-zA-Z_]+[a-zA-Z0-9_]* to string/^(KONG|OTEL)_[a-zA-Z_]+[a-zA-Z0-9_]* for status 200

      response-property-type-changed

  • 5c71c0f973d42See the full diff
    • ●

      added the new gcp enum value to the dataplane_group_config/items/provider response property for the response status 200

      response-property-enum-value-added

    • ●

      added the new gcp enum value to the dataplane_groups/items/provider response property for the response status 200

      response-property-enum-value-added

  • 7bc7400170e051See the full diff
    • ▲

      the response property dataplane_group_config/items/autoscale became optional for the status 200

      response-property-became-optional

    • ▲

      the response property dataplane_group_config/items/cloud_gateway_network_id became optional for the status 200

      response-property-became-optional

    • ▲

      the response property dataplane_groups/items/autoscale became optional for the status 200

      response-property-became-optional

    • ▲

      the response property dataplane_groups/items/cloud_gateway_network_id became optional for the status 200

      response-property-became-optional

    • ▲

      the response property version became optional for the status 200

      response-property-became-optional

    • ○

      added the optional property kind to the response with the 200 status

      response-optional-property-added

  • ddf026fbd25b1See the full diff
    • ●

      added the new sg enum value to the control_plane_geo response property for the response status 200

      response-property-enum-value-added

  • 3c0154b2053a10See the full diff
    • ▲

      the response property dataplane_group_config/items/autoscale/oneOf[subschema #2: Configuration Autoscale Autopilot]/max_rps became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dataplane_groups/items/autoscale/oneOf[subschema #2: Configuration Autoscale Autopilot]/max_rps became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dataplane_groups/items/egress_ip_addresses became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dataplane_groups/items/private_ip_addresses became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dataplane_groups/items/state_metadata/reason became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property dataplane_groups/items/state_metadata/reported_status became nullable for the status 200

      response-property-became-nullable

    • ▲

      the response property detail became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property instance became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property status became nullable for the status 401

      response-property-became-nullable

    • ▲

      the response property title became nullable for the status 401

      response-property-became-nullable

    This revision also has 1 change that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 6333a0d3b09511See the full diff
    • ▲

      the dataplane_group_config response's property type/format changed from / to array/ for status 200

      response-property-type-changed

    • ○

      removed ConfigurationDataPlaneGroupConfigs subschema #1 from the dataplane_group_config response property allOf list for the response status 200

      response-property-all-of-removed

    This revision also has 15 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 76b0fefddb0d11See the full diff
    • ▲

      the dataplane_group_config response's property type/format changed from array/ to / for status 200

      response-property-type-changed

    • ○

      added ConfigurationDataPlaneGroupConfigs subschema #1 to the dataplane_group_config response property allOf list for the response status 200

      response-property-all-of-added

  • 0aead68de7b02See the full diff
    • ○

      response property dataplane_group_config/items/autoscale/oneOf[subschema #1: Configuration Autoscale Static]/ deprecated

      response-property-deprecated

    • ○

      response property dataplane_groups/items/autoscale/oneOf[subschema #1: Configuration Autoscale Static]/ deprecated

      response-property-deprecated

    This revision also has 6 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 2a7df3ca52c82See the full diff
    • ○

      response property dataplane_group_config/items/autoscale/oneOf[subschema #2: Configuration Autoscale Autopilot]/max_rps deprecated

      response-property-deprecated

    • ○

      response property dataplane_groups/items/autoscale/oneOf[subschema #2: Configuration Autoscale Autopilot]/max_rps deprecated

      response-property-deprecated