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

A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to specific keys.

Kong KeySets 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 KeySets. 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 9 operations across 4 paths, and defines 5 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}.

9 operations 4 paths 5 schemas 2 DELETE3 GET2 POST2 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 KeySets 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 9

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

KeySets 9

A JSON Web key set. Key sets are the preferred way to expose keys to plugins because they tell the plugin where to look for keys or have a scoping mechanism to restrict plugins to…

POST
/{workspace}/key-sets
Create a new KeySet
create-key-set 1 param body → 201401
DELETE
/{workspace}/key-sets/{KeySetIdOrName}
Delete a KeySet
delete-key-set 3 params → 204401
GET
/{workspace}/key-sets/{KeySetIdOrName}
Get a KeySet
get-key-set 2 params → 200401404
PUT
/{workspace}/key-sets/{KeySetIdOrName}
Upsert a KeySet
upsert-key-set 2 params body → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/key-sets
List all KeySets
list-key-set 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/key-sets
Create a new KeySet
create-key-set 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}
Delete a KeySet
delete-key-set 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}
Get a KeySet
get-key-set 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/key-sets/{KeySetId}
Upsert a KeySet
upsert-key-set 2 params body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are KeySet (5 properties), KeySet_2 (5 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.

PaginationOffsetResponse
string
Offset is used to paginate through the API. Provide this value to the next list operation to fetch the next page
GatewayUnauthorizedError
object
2 properties 2 required
KeySet_2
object
5 properties
KeySet
object
5 properties
PaginationNextResponse
string
URI to the next page (may be null)

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

kong-keysets-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