HashiCorp Vault · Schema

Vault Secret

Represents a versioned secret stored in the Vault KV v2 secrets engine, including its data payload and version metadata.

EncryptionIdentityInfrastructureSecrets ManagementSecurity

Properties

Name Type Description
data object The secret key-value data
metadata object Version metadata for the secret
View JSON Schema on GitHub

JSON Schema

hvault-secret-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://developer.hashicorp.com/schemas/vault/secret.json",
  "title": "Vault Secret",
  "description": "Represents a versioned secret stored in the Vault KV v2 secrets engine, including its data payload and version metadata.",
  "type": "object",
  "properties": {
    "data": {
      "type": "object",
      "additionalProperties": true,
      "description": "The secret key-value data"
    },
    "metadata": {
      "type": "object",
      "properties": {
        "created_time": {
          "type": "string",
          "format": "date-time",
          "description": "When this version was created"
        },
        "custom_metadata": {
          "type": "object",
          "additionalProperties": {
            "type": "string"
          },
          "description": "Custom metadata key-value pairs"
        },
        "deletion_time": {
          "type": "string",
          "description": "When this version was deleted (empty if not deleted)"
        },
        "destroyed": {
          "type": "boolean",
          "description": "Whether this version has been permanently destroyed"
        },
        "version": {
          "type": "integer",
          "description": "Version number"
        }
      },
      "description": "Version metadata for the secret"
    }
  }
}