Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Kong Control Plane Groups API

The Control Plane Groups API from Kong — 5 operation(s) for control plane groups.

Kong Control Plane Groups 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 Control Plane Groups. 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 6 operations across 5 paths, and defines 23 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}.

6 operations 5 paths 23 schemas 3 GET2 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
3.14.0
Base URL
https://konghq.com/
Authentication
API Key
Contact
License
Resource Areas
1

Authentication & Security 1

Kong Control Plane Groups 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 6

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

Control Plane Groups 6
GET
/v2/control-planes/{controlPlaneId}/group-member-status
Get Control Plane Group Member Status
get-control-planes-id-group-member-status 1 param → 200400401403404500503
GET
/v2/control-planes/{controlPlaneId}/group-memberships
List Control Plane Group Memberships
get-control-planes-id-group-memberships 3 params → 200400401403404500503
PUT
/v2/control-planes/{controlPlaneId}/group-memberships
Upsert Control Plane Group Members
put-control-planes-id-group-memberships 1 param body → 204400401403404500503
POST
/v2/control-planes/{controlPlaneId}/group-memberships/add
Add Control Plane Group Members
post-control-planes-id-group-memberships-add 1 param body → 204400401403404500503
POST
/v2/control-planes/{controlPlaneId}/group-memberships/remove
Remove Control Plane Group Members
post-control-planes-id-group-memberships-remove 1 param body → 204400401403404500503
GET
/v2/control-planes/{controlPlaneId}/group-status
Get Control Plane Group Status
get-control-planes-id-group-status 1 param → 200400401403404500503

Schemas 23

The contract defines 23 schemas that model the data the API accepts and returns. The most detailed are ControlPlane (7 properties), BaseError (5 properties), InvalidParameterMaximumLength (5 properties), GroupStatus (5 properties). Each schema is shown below with its type and property counts.

InvalidParameterMinimumLength
object
5 properties 4 required
CursorPaginatedMetaWithSizeAndTotal
object
returns the pagination information
1 property 1 required
ControlPlane
object
The control plane object contains information about a Kong control plane.
7 properties 7 required
InvalidParameterChoiceItem
object
5 properties 4 required
InvalidParameterMaximumLength
object
5 properties 4 required
GroupMemberStatus
object
Object with information determining the group membership status of a control plane.
1 property 1 required
ForbiddenError
GroupConflict
object
The Group Conflict object contains information about a conflict in a control plane group.
3 properties 3 required
UnauthorizedError
Labels
object
Labels store metadata of an entity that can be used for filtering an entity list or for searching across entity types. Keys must be of length 1-63 characters,…
ProxyURLs
array
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
GroupMembership
object
1 property 1 required
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
InvalidRules
string
invalid parameters rules
GroupStatus
object
The Group Status object contains information about the status of a control plane group.
5 properties 4 required
InvalidParameters
array
invalid parameters
BadRequestError
ProxyURL
object
Proxy URL associated with reaching the data-planes connected to a control-plane.
3 properties 3 required
InvalidParameterStandard
object
4 properties 2 required
CursorMetaWithSizeAndTotal
object
3 properties 2 required
NotFoundError
GroupConflictResource
object
A resource causing a conflict in a control plane group.
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-control-plane-groups-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 ACLs API
Kong Add-Ons API
Kong API API
Kong API Attributes API
Kong API Documentation API