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

HashiCorp Vault Secrets - KV v2 API

Key/Value secrets engine version 2

HashiCorp Vault Secrets - KV v2 API is one of 9 APIs that HashiCorp Vault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Secrets - KV v2. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, authentication docs, and a getting-started guide.

This API exposes 8 operations across 5 paths. It is described by OpenAPI 3.1.0, at version 1.15.0.

Requests are made against 2 base URLs: https://127.0.0.1:8200/v1, https://{vault_host}:{port}/v1.

8 operations 5 paths 0 schemas 2 DELETE2 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.1.0
API Version
1.15.0
Base URL
https://127.0.0.1:8200/v1
Authentication
API Key
Contact
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Secrets - KV v2 API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Vault-Token (VaultToken). By default, every request must be authenticated.

  • VaultToken — Vault client token

Paths & Operations 8

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

Secrets - KV v2 8

Key/Value secrets engine version 2

GET
/secret/data/{path}
Read KV secret (v2)
readKVSecret 2 params → 200404
POST
/secret/data/{path}
Create or update KV secret (v2)
createKVSecret 1 param body → 200
DELETE
/secret/data/{path}
Delete latest version of KV secret
deleteKVSecretLatest 1 param → 204
GET
/secret/metadata/{path}
Read KV secret metadata
getKVMetadata 1 param → 200
DELETE
/secret/metadata/{path}
Delete all versions and metadata
deleteKVMetadata 1 param → 204
POST
/secret/delete/{path}
Delete specific versions of KV secret
deleteKVSecretVersions 1 param body → 204
POST
/secret/undelete/{path}
Undelete versions of KV secret
undeleteKVSecretVersions 1 param body → 204
POST
/secret/destroy/{path}
Permanently destroy versions
destroyKVSecretVersions 1 param body → 204

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

hashicorp-vault-secrets-kv-v2-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

HashiCorp Vault Auth - AppRole API
HashiCorp Vault Auth - Token API
HashiCorp Vault Auth - Userpass API
HashiCorp Vault Identity API
HashiCorp Vault Leases API
HashiCorp Vault Policy API
HashiCorp Vault Secrets - Transit API
HashiCorp Vault System API