HashiCorp Vault · JSON Structure

Vault Kv Secret Metadata Request Structure

SecretMetadataRequest schema from HashiCorp Vault API

Type: object Properties: 4
DevOpsEncryptionOpen SourcePKISecrets ManagementSecurity

SecretMetadataRequest is a JSON Structure definition published by HashiCorp Vault, describing 4 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

max_versions cas_required delete_version_after custom_metadata

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vault/refs/heads/main/json-structure/vault-kv-secret-metadata-request-structure.json",
  "name": "SecretMetadataRequest",
  "description": "SecretMetadataRequest schema from HashiCorp Vault API",
  "type": "object",
  "properties": {
    "max_versions": {
      "type": "int32",
      "minimum": 0,
      "description": "Maximum number of versions to keep for this specific secret.",
      "example": 10
    },
    "cas_required": {
      "type": "boolean",
      "description": "When true, write operations require CAS parameter.",
      "example": false
    },
    "delete_version_after": {
      "type": "string",
      "description": "Duration after which versions are automatically soft-deleted.",
      "example": "0s"
    },
    "custom_metadata": {
      "type": "object",
      "description": "User-provided key-value metadata stored alongside the secret.",
      "additionalProperties": {
        "type": "string"
      },
      "example": {
        "owner": "platform-team",
        "environment": "production"
      }
    }
  }
}