HashiCorp Vault · Schema

SecretMetadataRequest

SecretMetadataRequest schema from HashiCorp Vault API

DevOpsEncryptionOpen SourcePKISecrets ManagementSecurity

Properties

Name Type Description
max_versions integer Maximum number of versions to keep for this specific secret.
cas_required boolean When true, write operations require CAS parameter.
delete_version_after string Duration after which versions are automatically soft-deleted.
custom_metadata object User-provided key-value metadata stored alongside the secret.
View JSON Schema on GitHub

JSON Schema

vault-kv-secret-metadata-request-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/vault/refs/heads/main/json-schema/vault-kv-secret-metadata-request-schema.json",
  "title": "SecretMetadataRequest",
  "description": "SecretMetadataRequest schema from HashiCorp Vault API",
  "type": "object",
  "properties": {
    "max_versions": {
      "type": "integer",
      "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"
      }
    }
  }
}