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

Vault objects are used to configure different vault connectors for [managing secrets](https://developer.konghq.com/gateway/secrets-management/).Configuring a vault lets you reference secrets from other entities.This allows for a proper separation of secrets and configuration and prevents secret sprawl.For example, you could store a certificate and a key in a vault, then reference them from a certificate entity. This way, the certificate and key are not stored in the entity directly and are more secure.Secrets rotation can be managed using [TTLs](https://developer.konghq.com/gateway/entities/vault/).

Kong Vaults 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 Vaults. 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 Vaults 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.

Vaults 9

Vault objects are used to configure different vault connectors for [managing secrets](https://developer.konghq.com/gateway/secrets-management/). Configuring a vault lets you refer…

POST
/{workspace}/vaults
Create a new Vault
create-vault 1 param body → 201401
DELETE
/{workspace}/vaults/{VaultIdOrPrefix}
Delete a Vault
delete-vault 3 params → 204401
GET
/{workspace}/vaults/{VaultIdOrPrefix}
Get a Vault
get-vault 2 params → 200401404
PUT
/{workspace}/vaults/{VaultIdOrPrefix}
Upsert a Vault
upsert-vault 2 params body → 200401
GET
/v2/control-planes/{controlPlaneId}/core-entities/vaults
List all Vaults
list-vault 4 params → 200401
POST
/v2/control-planes/{controlPlaneId}/core-entities/vaults
Create a new Vault
create-vault 1 param body → 201401
DELETE
/v2/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
Delete a Vault
delete-vault 3 params → 204401
GET
/v2/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
Get a Vault
get-vault 2 params → 200401404
PUT
/v2/control-planes/{controlPlaneId}/core-entities/vaults/{VaultId}
Upsert a Vault
upsert-vault 2 params body → 200401

Schemas 5

The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Vault_2 (8 properties), Vault (8 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
PaginationNextResponse
string
URI to the next page (may be null)
Vault
object
Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configu…
8 properties 2 required
Vault_2
object
Vault entities are used to configure different Vault connectors. Examples of Vaults are Environment Variables, Hashicorp Vault and AWS Secrets Manager. Configu…
8 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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