Data-Plane Group Configurations

Create Configuration

Changed on

Creates or replaces the Cloud Gateway configuration for a control plane and geo. The request fully describes the desired state — Kong diffs it against the current configuration, then adds, removes, or updates data plane groups to match. Any network referenced in the request that is currently offline automatically transitions to initializing.

For a Dedicated API gateway, use kind: dedicated.v0 and type: api (both defaults); version, cloud_gateway_network_id, and autoscale are required. For a Dedicated AI gateway, use kind: dedicated.v0 and type: ai; cloud_gateway_network_id is required, while version, autoscale, and environment must be omitted. For a Serverless gateway, use kind: serverless.v1; version, cloud_gateway_network_id, and autoscale must be omitted.

put/v2/cloud-gateways/configurations

Request

  • Base URL: https://global.api.konghq.com
  • URL: https://global.api.konghq.com/v2/cloud-gateways/configurations
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer
    • HTTP bearer

Request body

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
versionstring

Supported gateway version. For serverless.v1 cloud gateways and dedicated AI gateways (kind: dedicated.v0 and type: ai), this field should be omitted.

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.

type'api' | 'ai'

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

Type of Cloud Gateway: api for an API Gateway or ai for an AI Gateway. Applies only to dedicated Cloud Gateways. Defaults to api when 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

Dedicated AI gateways (kind: dedicated.v0 and type: ai) support only private or public; the default is public. The private+public value is not supported for dedicated AI gateways. For other gateway types, the default is private+public.

Example request

{
  "control_plane_id": "0949471e-b759-45ba-87ab-ee63fb781388",
  "version": "3.10",
  "dataplane_groups": [
    {
      "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"
        }
      ]
    }
  ],
  "api_access": "private+public"
}

Response

Response format for creating a configuration.

idstring uuid required
versionstring

Supported gateway version. For serverless.v1 cloud gateways and dedicated AI gateways (kind: dedicated.v0 and type: ai), 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

Dedicated AI gateways (kind: dedicated.v0 and type: ai) support only private or public; the default is public. The private+public value is not supported for dedicated AI gateways. For other gateway types, the default is private+public.

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.

type'api' | 'ai'

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

Type of Cloud Gateway: api for an API Gateway or ai for an AI Gateway. Applies only to dedicated Cloud Gateways. Defaults to api when omitted.

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

  • 7aab863a6daaRevision changes
    • breaking

      added to the / response property oneOf list for the response status

    • warning

      added the new key_invalid enum value to the ////// response property for the response status

    • warning

      added the new unique enum value to the ////// response property for the response status

  • 039608cd302fRevision changes
    • info

      added the new optional request property

    • info

      the request property default value private+public was removed

    • info

      added the optional property to the response with the status

    • info

      the response's property default value private+public was removed for the status