---
title: "Get Configuration"
method: GET
path: "/v2/cloud-gateways/configurations/{configurationId}"
tags: ["Data-Plane Group Configurations"]
---

# Get Configuration

`GET /v2/cloud-gateways/configurations/{configurationId}`

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

## Path parameters

- `configurationId` string, uuid, required

## Response `200`

Response format for retrieving a configuration by ID.

- ConfigurationManifest — Object containing information about a control-plane's cloud-gateways configuration.
  - `id` string, uuid, required
  - `version` string, required — Supported gateway version.
  - `api_access` 'private' | 'public' | 'private+public' — Type of API access data-plane groups will support for a configuration.
  - `dataplane_group_config` ConfigurationDataPlaneGroupConfig[], required — Object that describes where data-planes will be deployed to, along with how many instances.
    - `provider` 'aws' | 'azure', required — Name of cloud provider.
    - `region` string, required — Region ID for cloud provider region.
    - `cloud_gateway_network_id` string, uuid, required
    - `autoscale` union, required
      - ConfigurationDataPlaneGroupAutoscaleStatic — Object that describes the static autoscaling strategy.
        - `kind` 'static', required
        - `instance_type` 'small' | 'medium' | 'large', required — Instance type name to indicate capacity.
        - `requested_instances` integer, required — Number of data-planes the deployment target will contain.
      - ConfigurationDataPlaneGroupAutoscaleAutopilot — Object that describes the autopilot autoscaling strategy.
        - `kind` 'autopilot', required
        - `base_rps` integer, required — Base number of requests per second that the deployment target should support.
        - `max_rps` integer — Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
    - `environment` ConfigurationDataPlaneGroupEnvironmentField[] — Array of environment variables to set for a data-plane group.
      - `name` string, ^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*, required — Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
      - `value` string, required — Value assigned to the environment variable field for the data-plane group.
  - `dataplane_groups` ConfigurationDataPlaneGroup[], required — List of data-plane groups that describe where data-planes will be deployed to, along with how many instances.
    - `id` string, uuid, required — ID of the data-plane group that represents a deployment target for a set of data-planes.
    - `provider` 'aws' | 'azure', required — Name of cloud provider.
    - `region` string, required — Region ID for cloud provider region.
    - `autoscale` union, required
      - ConfigurationDataPlaneGroupAutoscaleStatic — Object that describes the static autoscaling strategy.
        - `kind` 'static', required
        - `instance_type` 'small' | 'medium' | 'large', required — Instance type name to indicate capacity.
        - `requested_instances` integer, required — Number of data-planes the deployment target will contain.
      - ConfigurationDataPlaneGroupAutoscaleAutopilot — Object that describes the autopilot autoscaling strategy.
        - `kind` 'autopilot', required
        - `base_rps` integer, required — Base number of requests per second that the deployment target should support.
        - `max_rps` integer — Max number of requests per second that the deployment target should support. If not set, this defaults to 10x base_rps.
    - `environment` ConfigurationDataPlaneGroupEnvironmentField[] — Array of environment variables to set for a data-plane group.
      - `name` string, ^KONG_[a-zA-Z_]+[a-zA-Z0-9_]*, required — Name of the environment variable field to set for the data-plane group. Must be prefixed by KONG_.
      - `value` string, required — Value assigned to the environment variable field for the data-plane group.
    - `cloud_gateway_network_id` string, uuid, required
    - `state` 'created' | 'initializing' | 'ready' | 'terminating' | 'terminated', required — State of the data-plane group.
    - `private_ip_addresses` string[] — List of private IP addresses of the internal load balancer that proxies traffic to this data-plane group.
    - `egress_ip_addresses` string[] — List of egress IP addresses for the network that this data-plane group runs on.
    - `created_at` string, date-time, required — An RFC-3339 timestamp representation of data-plane group creation date.
    - `updated_at` string, date-time, required — An RFC-3339 timestamp representation of data-plane group update date.
  - `entity_version` number, required — Positive, monotonically increasing version integer, to serialize configuration changes.
  - `created_at` string, date-time, required — An RFC-3339 timestamp representation of configuration creation date.
  - `updated_at` string, date-time, required — An RFC-3339 timestamp representation of configuration update date.
  - `control_plane_id` string, uuid, required
  - `control_plane_geo` 'us' | 'eu' | 'au', required — Set of control-plane geos supported for deploying cloud-gateways configurations.

## Other responses

- `401` — Unauthorized
- `403` — Forbidden
- `404` — Not Found

## Changes

- **2024-11-11** `08ead66e9ebb` — 2 warning, 2 info
  - added the new `azure` enum value to the `dataplane_group_config/items/provider` response property for the response status `200`
  - added the new `azure` enum value to the `dataplane_groups/items/provider` response property for the response status `200`
  - added the optional property `dataplane_group_config/items/environment` to the response with the `200` status
  - added the optional property `dataplane_groups/items/environment` to the response with the `200` status
- **2024-09-11** `be7c36317ba6` — 1 breaking
  - the `dataplane_groups` response's property format changed from no format to `set` for status `200`

[Change history](https://skmtc.dev/kong/apis/konnect-api/changes/v2/cloud-gateways/configurations/:configurationId/get.md)

---

[API](https://skmtc.dev/kong/apis/konnect-api.md) · [All operations](https://skmtc.dev/kong/apis/konnect-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kong/konnect-api/revisions/19bbc8a36404/schema)