How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Data-Plane Group Configurations API

The Data-Plane Group Configurations API from Kong — 2 operation(s) for data-plane group configurations.

Kong Data-Plane Group Configurations API is one of 139 APIs that Kong publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Data-Plane Group Configurations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, a GitHub repository, an API reference, authentication docs, and 1 JSON Schema.

This API exposes 3 operations across 2 paths, and defines 42 schemas. It is described by OpenAPI 3.2.0, at version 3.14.0.

Requests are made against 4 base URLs: https://global.api.konghq.com, https://us.api.konghq.com, https://eu.api.konghq.com, https://au.api.konghq.com.

3 operations 2 paths 42 schemas 2 GET1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
3.14.0
Base URL
https://global.api.konghq.com
Authentication
HTTP Bearer, HTTP Bearer, HTTP Bearer, HTTP Bearer
Contact
License
Resource Areas
1

Authentication & Security 4

Kong Data-Plane Group Configurations API declares 4 security schemes for authenticating requests. It accepts HTTP bearer tokens (Token) (personalAccessToken). It accepts HTTP bearer tokens (Token) (systemAccountAccessToken). It accepts HTTP bearer tokens (JWT) (konnectAccessToken). It accepts HTTP bearer tokens (JWT) (serviceAccessToken). By default, every request must be authenticated.

  • personalAccessToken — The personal access token is meant to be used as an alternative to basic-auth when accessing Konnect via APIs. You can generate a Personal Access Token (PAT) f…
  • systemAccountAccessToken — The system account access token is meant for automations and integrations that are not directly associated with a human identity. You can generate a system acc…
  • konnectAccessToken — The Konnect access token is meant to be used by the Konnect dashboard and the decK CLI to authenticate with.
  • serviceAccessToken — The Service access token is meant to be used between internal services.

Paths & Operations 3

Across 2 paths, the API surfaces 3 operations — 2 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Data-Plane Group Configurations 3
GET
/v2/cloud-gateways/configurations
List Configurations
list-configurations 3 params → 200400401403
PUT
/v2/cloud-gateways/configurations
Create Configuration
create-configuration body → 200400401403404409
GET
/v2/cloud-gateways/configurations/{configurationId}
Get Configuration
get-configuration 1 param → 200401403404

Schemas 42

The contract defines 42 schemas that model the data the API accepts and returns. The most detailed are ConfigurationDataPlaneGroup (12 properties), ConfigurationManifest (11 properties), CreateConfigurationRequest (6 properties), CreateConfigurationDataPlaneGroup (5 properties). Each schema is shown below with its type and property counts.

ConfigurationDataPlaneGroupEnvironmentField
object
Environment variable name and value to set for a data-plane group.
2 properties 2 required
ProviderRegionId
string
Region ID for cloud provider region.
ApiAccess
string
Type of API access data-plane groups will support for a configuration.
CreateConfigurationDataPlaneGroup
object
Object that describes where to deploy a data-plane group, along with how many instances.
5 properties 2 required
ConfigurationDataPlaneGroupAutoscale
ConfigurationKind
string
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 follow…
CreateConfigurationRequest
object
Request schema for creating a configuration.
6 properties 3 required
ConfigurationDataPlaneGroupAutoscaleAutopilot
object
Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.
3 properties 2 required
ControlPlaneGeoFieldOrEqualityFilter
object
Filter a control-plane geo by determining if the value is equal to any in a set of values, where the set is a comma-delimited list.
1 property 1 required
InvalidParameterChoiceItem
object
5 properties 4 required
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property 1 required
ConfigurationId
string
IDFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
BaseError
object
standard error
5 properties 4 required
InvalidParameters
array
invalid parameters
ProviderName
string
Name of cloud provider.
BadRequestError
PaginatedMeta
object
returns the pagination information
1 property 1 required
ConfigurationDataPlaneGroupAutoscaleStatic
object
Object that describes the static autoscaling strategy. Deprecated in favor of the autopilot autoscaling strategy. Static autoscaling will be removed in a futur…
3 properties 3 required
InvalidParameterMinimumLength
object
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
NotFoundError
ForbiddenError
UnauthorizedError
ConfigurationDataPlaneGroupConfig
object
Object that describes where a data-plane group will be deployed to, along with how many instances.
5 properties 2 required
ConfigurationsFilterParameters
object
2 properties
InvalidRules
string
invalid parameters rules
InvalidParameterMaximumLength
object
5 properties 4 required
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
InstanceTypeName
string
Instance type name to indicate capacity.
ControlPlaneId
string
GatewayVersion
string
Supported gateway version. For serverless.v1 kind of cloud gateways, this field should be omitted.
ConflictError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
ControlPlaneGeoFieldFilter
ConfigurationDataPlaneGroupEnvironment
array
Array of environment variables to set for a data-plane group.
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
ConfigurationManifest
object
Object containing information about a control-plane's cloud-gateways configuration.
11 properties 8 required
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo by exact match.
InvalidParameterStandard
object
4 properties 2 required
DataPlaneGroupId
string
ID of the data-plane group that represents a deployment target for a set of data-planes.
ConfigurationDataPlaneGroup
object
Object that describes the set of data-plane groups currently pointed to this configuration.
12 properties 6 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-data-plane-group-configurations-api-openapi.yml Raw ↑

Other APIs Kong publishes across the network.

Kong Gateway
Kong AI Gateway
Kong Agent Gateway
Kong MCP Registry
Kong Context Mesh
Kong Mesh
Kong Insomnia
Kong Add-Ons API
Kong API Attributes API
Kong API Documentation API
Kong API Image API
Kong API Implementation API
Where this information came from

This is an independent, third-party profile of Kong Data-Plane Group Configurations API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.