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

Manage metadata and version history for KV v2 secrets.

HashiCorp Vault Secrets Metadata 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 Metadata. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, a JSON-LD context, and 5 JSON Schemas.

This API exposes 3 operations across 1 path, and defines 4 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.

3 operations 1 paths 4 schemas 1 DELETE1 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://vault.example.com/v1
Authentication
API Key
License
Terms of Service
Resource Areas
1

Authentication & Security 1

HashiCorp Vault Secrets Metadata 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 3

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

Secrets Metadata 3

Manage metadata and version history for KV v2 secrets.

GET
/secret/metadata/{path}
HashiCorp Vault Read Secret Metadata
readSecretMetadata 1 param → 200403404
POST
/secret/metadata/{path}
HashiCorp Vault Write Secret Metadata
writeSecretMetadata 1 param body → 204400403
DELETE
/secret/metadata/{path}
HashiCorp Vault Delete Secret Metadata
deleteSecretMetadata 1 param → 204403

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are SecretVersionMetadata (4 properties), SecretMetadataRequest (4 properties), SecretMetadataResponse (1 property), VaultError (1 property). Each schema is shown below with its type and property counts.

SecretMetadataRequest
object
4 properties
VaultError
object
1 property
SecretVersionMetadata
object
4 properties
SecretMetadataResponse
object
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

vault-secrets-metadata-api-openapi.yml Raw ↑

Other APIs HashiCorp Vault publishes across the network.

Vault HTTP API
HashiCorp Vault Auth Methods API
HashiCorp Vault Health API
HashiCorp Vault Leases API
HashiCorp Vault Policies API
HashiCorp Vault Secrets Config API
HashiCorp Vault Secrets Data API
HashiCorp Vault Secrets Engines API