Kong Keys API
A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operations, it can use this entity.
Kong Keys 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 Keys. 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 14 operations across 6 paths, and defines 6 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}.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Kong Keys 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 14
Across 6 paths, the API surfaces 14 operations — 3 DELETE, 5 GET, 3 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.
A key object holds a representation of asymmetric keys in various formats. When Kong Gateway or a Kong plugin requires a specific public or private key to perform certain operatio…
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are Key (10 properties), KeyWithoutParents (10 properties), Key_2 (10 properties), GatewayUnauthorizedError (2 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Kong 12
Other APIs Kong publishes across the network.