HashiCorp Vault Secrets Data API
Read, write, patch, and delete secret data versions in the KV v2 engine.
HashiCorp Vault Secrets Data API is one of 9 APIs that HashiCorp Vault publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 5 JSON Schema definitions.
Tagged areas include Secrets Data. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.
This API exposes 6 operations across 4 paths, and defines 6 schemas. It is described by OpenAPI 3.0.3, at version 2.0.
Requests are made against a single base URL, https://vault.example.com/v1.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
HashiCorp Vault Secrets Data 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 token for authenticating API requests. Tokens can be created via login endpoints or the token auth method. The token must have appropriate policy permiss…
Paths & Operations 6
Across 4 paths, the API surfaces 6 operations — 1 DELETE, 1 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Read, write, patch, and delete secret data versions in the KV v2 engine.
Schemas 6
The contract defines 6 schemas that model the data the API accepts and returns. The most detailed are SecretVersionMetadata (4 properties), SecretDataRequest (2 properties), SecretDataResponse (1 property), VaultError (1 property). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from HashiCorp Vault 8
Other APIs HashiCorp Vault publishes across the network.