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.1.0, at version 3.14.0.
Requests are made against a single base URL, {protocol}://{hostname}:{port}{path}.
3 operations2 paths42 schemas2 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
Kong Data-Plane Group Configurations API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as Kong-Admin-Token (adminToken).
By default, every request must be authenticated.
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.
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), InvalidParameterDependentItem (5 properties). Each schema is shown below with its type and property counts.
InvalidParameterMinimumLength
object
5 properties4 required
ConfigurationsFilterParameters
object
2 properties
ControlPlaneGeo
string
Set of control-plane geos supported for deploying cloud-gateways configurations.
ConfigurationDataPlaneGroupAutoscaleAutopilot
object
Object that describes the autopilot autoscaling strategy. For serverless.v1 kind of cloud gateways, this field should be omitted.
3 properties2 required
ConfigurationId
string
ControlPlaneId
string
ControlPlaneGeoFieldEqualsFilter
Filter a control-plane geo by exact match.
ConflictError
InvalidParameterChoiceItem
object
5 properties4 required
ConfigurationDataPlaneGroupConfig
object
Object that describes where a data-plane group will be deployed to, along with how many instances.
5 properties2 required
InvalidParameterMaximumLength
object
5 properties4 required
GatewayVersion
string
Supported gateway version. 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 properties8 required
ConfigurationDataPlaneGroupEnvironmentField
object
Environment variable name and value to set for a data-plane group.
2 properties2 required
ForbiddenError
UnauthorizedError
ConfigurationDataPlaneGroupEnvironment
array
Array of environment variables to set for a data-plane group.
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…
PaginatedMeta
object
returns the pagination information
1 property1 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 properties3 required
ProviderName
string
Name of cloud provider.
CreateConfigurationDataPlaneGroup
object
Object that describes where to deploy a data-plane group, along with how many instances.
5 properties2 required
ApiAccess
string
Type of API access data-plane groups will support for a configuration.
BaseError
object
standard error
5 properties4 required
InvalidParameterDependentItem
object
5 properties4 required
ControlPlaneGeoFieldFilter
DataPlaneGroupId
string
ID of the data-plane group that represents a deployment target for a set of data-planes.
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 property1 required
ConfigurationDataPlaneGroup
object
Object that describes the set of data-plane groups currently pointed to this configuration.
12 properties6 required
InstanceTypeName
string
Instance type name to indicate capacity.
BadRequestError
InvalidParameters
array
invalid parameters
InvalidRules
string
invalid parameters rules
IDFieldFilter
object
Filter using one of the following operators: eq, oeq, neq
3 properties
InvalidParameterStandard
object
4 properties2 required
ProviderRegionId
string
Region ID for cloud provider region.
NetworkId
string
The network ID to operate on. For serverless.v1 kind of cloud gateways, this field should be omitted.
CreateConfigurationRequest
object
Request schema for creating a configuration.
6 properties3 required
NotFoundError
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties3 required
ControlPlaneGeoFieldNotEqualsFilter
object
Filter a control-plane geo by inequality match.
1 property1 required
ConfigurationDataPlaneGroupAutoscale
Specification
The full machine-readable OpenAPI contract behind this narrative.
