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 Planes API

The Control Planes API from Kong — 2 operation(s) for control planes.

Kong Control Planes 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 Planes. 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 5 operations across 2 paths, and defines 24 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}.

5 operations 2 paths 24 schemas 1 DELETE2 GET1 PATCH1 POST

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 Planes 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 5

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

Control Planes 5
GET
/v2/control-planes
List Control Planes
list-control-planes 5 params → 200400401403500503
POST
/v2/control-planes
Create Control Plane
create-control-plane body → 201400401403409500503
GET
/v2/control-planes/{controlPlaneId}
Get a Control Plane
get-control-plane 1 param → 200400401403404500503
PATCH
/v2/control-planes/{controlPlaneId}
Update Control Plane
update-control-plane 1 param body → 200400401403404500503
DELETE
/v2/control-planes/{controlPlaneId}
Delete Control Plane
delete-control-plane 1 param → 204400401403404500503

Schemas 24

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

InvalidParameterMinimumLength
object
5 properties 4 required
ControlPlane
object
The control plane object contains information about a Kong control plane.
7 properties 7 required
InvalidParameterChoiceItem
object
5 properties 4 required
ConflictError
InvalidParameterMaximumLength
object
5 properties 4 required
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,…
ForbiddenError
ControlPlaneFilterParameters
object
4 properties
UnauthorizedError
UpdateControlPlaneRequest
object
The request schema for the update control plane request.
5 properties
PaginatedMeta
object
returns the pagination information
1 property 1 required
ProxyURLs
array
Array of proxy URLs associated with reaching the data-planes connected to a control-plane.
BooleanFieldFilter
boolean
Filter by a boolean value (true/false).
BaseError
object
standard error
5 properties 4 required
InvalidParameterDependentItem
object
5 properties 4 required
CreateControlPlaneRequest
object
The request schema for the create control plane request.
7 properties 1 required
SortQuery
string
The asc suffix is optional as the default sort order is ascending. The desc suffix is used to specify a descending order. Multiple sort attributes may be provi…
InvalidRules
string
invalid parameters rules
InvalidParameters
array
invalid parameters
BadRequestError
InvalidParameterStandard
object
4 properties 2 required
PageMeta
object
Contains pagination query parameters and the total number of objects returned.
3 properties 3 required
NotFoundError
ProxyURL
object
Proxy URL associated with reaching the data-planes connected to a control-plane.
3 properties 3 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-control-planes-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