License utilization metrics

Enterprise

Appropriate Vault Enterprise license required

Vault Enterprise license utilization reporting shares the minimum data required to validate license utilization as defined in Vault Enterprise license agreements. This data consists of computed metrics and never contains personally identifiable information (PII) or sensitive secrets.

In Vault 2.0 and later, reports include:

Vault clients. The number of unique Vault clients.
Vault usage. A single usage metric for each secrets engine, plus the number of enabled custom plugins and KMIP status.
PKI certificates. The number of certificates issued by Vault's built-in PKI secrets engine.

Not all metrics are relevant to all contracts. For example, when a Vault cluster is entitled by Vault clients, only Vault client metrics apply to that cluster's license utilization.

Data schema

Reporting payload

Vault's license utilization reporting payload includes the following fields:

id - Random identifier for the payload
mode - Marked as manual when Vault generates the payload at the user's request, otherwise omitted
version - The version of this payload schema
timestamp - The date and time for this contribution
snapshot_records - An array of snapshot records. See snapshot payload for the contents of each snapshot record.

Snapshot payload

Each snapshot_record includes the following fields:

snapshot_version - The version of the snapshot package that produced the reporting snapshot
data - The base64-encoded binary contents of the snapshot
checksum - A hash of the snapshot data used to validate the integrity of the snapshot
signature - A signature of the snapshot data used to validate the authenticity of the snapshot
license - A structure containing information about the license key in use when the snapshot was taken
- id - The license ID
- issuer - The issuer of the license
- customer - The customer ID associated with the license
decoded_snapshot - The decoded contents of the snapshot, which is a structure containing the following fields:
- snapshot_version - The version of the snapshot package that produced the reporting snapshot
- id - A unique identifier for this snapshot
- process_id - An identifier for the system that produced this snapshot
- timestamp - The date and time for this snapshot
- schema_version - The version of the schema associated with this snapshot
- product - The product that this contribution is for
- product_version - The product version this contribution is for
- license_id - A structure containing information about the license in use when the snapshot was taken
- gauges - A map of representations of snapshot metrics contained within this snapshot
  - key - The key name associated with this metric
  - value - The value associated with this metric
  - mode - The mode of operation associated with this metric (write or collect)
- metadata - Optional product-specific metadata
  - billing_start - The billing start date associated with the reporting cluster or the license start date if you do not have a billing date configured (automatically rolls over every year)
  - cluster_id - The cluster UUID as shown by vault status on the reporting cluster
  - development_cluster - Whether or not the cluster operates as a development (non-production) cluster
  - add_ons - For IBM Passport Advantage Online license keys, the add-ons associated with the entitlement. For HashiCorp license keys, this field is empty.
  - edition - For IBM Passport Advantage Online license keys, the edition associated with the entitlement. For HashiCorp license keys, this field is empty.
  - issuer - The issuer of the license key
  - license_start_time - The start time of the license key
  - license_expiration_time - The expiration time of the license key
  - license_termination_time - The termination time of the license key, if applicable

License utilization metrics

Client count metrics

Metric	Description
`clientcount.current_month_estimate.type.entity`	Estimated total entity client count for the current billing period to date.
`clientcount.previous_month_complete.type.entity`	Exact total entity client count for the entire billing period until the end of last month.
`clientcount.current_month_estimate.type.nonentity`	Estimated total nonentity client count for the current billing period to date.
`clientcount.previous_month_complete.type.nonentity`	Exact total nonentity client count for the entire billing period until the end of last month.
`clientcount.current_month_estimate.type.secret_sync`	Estimated secret sync count for the current billing period to date.
`clientcount.previous_month_complete.type.secret_sync`	Exact total secret sync count for the entire billing period until the end of last month.
`clientcount.current_month_estimate.type.acme_client`	Estimated ACME client count for the current billing period to date.
`clientcount.previous_month_complete.type.acme_client`	Exact total ACME client count for the entire billing period until the end of last month.

Usage-based metrics

Metric	Description
`alicloud_dynamic_max_role_count.current_month_estimate`	High watermark count of Alicloud dynamic roles in the current month.
`alicloud_dynamic_max_role_count.previous_month_complete`	High watermark count of Alicloud dynamic roles in the previous month.
`aws_dynamic_max_role_count.current_month_estimate`	High watermark count of AWS dynamic roles in the current month.
`aws_dynamic_max_role_count.previous_month_complete`	High watermark count of AWS dynamic roles in the previous month.
`aws_static_max_role_count.current_month_estimate`	High watermark count of AWS static roles in the current month.
`aws_static_max_role_count.previous_month_complete`	High watermark count of AWS static roles in the previous month.
`azure_dynamic_max_role_count.current_month_estimate`	High watermark count of Azure dynamic roles in the current month.
`azure_dynamic_max_role_count.previous_month_complete`	High watermark count of Azure dynamic roles in the previous month.
`azure_static_max_role_count.current_month_estimate`	High watermark count of Azure static roles in the current month.
`azure_static_max_role_count.previous_month_complete`	High watermark count of Azure static roles in the previous month.
`billing.ssh.normalized_certificates.current_month_estimate`	Estimated number of certificates issued by built-in SSH backends in the current month.
`billing.ssh.normalized_certificates.previous_month_complete`	Number of certificates issued by built-in SSH backends in the previous month.
`billing.ssh.otp.current_month_estimate`	Estimated number of OTPs issued by built-in SSH backends in the current month.
`billing.ssh.otp.previous_month_complete`	Number of OTPs issued by built-in SSH backends in the previous month.
`consul_max_role_count.current_month_estimate`	High watermark count of Consul roles in the current month.
`consul_max_role_count.previous_month_complete`	High watermark count of Consul roles in the previous month.
`database_dynamic_max_role_count.current_month_estimate`	High watermark count of Database dynamic roles in the current month.
`database_dynamic_max_role_count.previous_month_complete`	High watermark count of Database dynamic roles in the previous month.
`database_static_max_role_count.current_month_estimate`	High watermark count of Database static roles in the current month.
`database_static_max_role_count.previous_month_complete`	High watermark count of Database static roles in the previous month.
`gcp_impersonated_max_account_count.current_month_estimate`	High watermark count of GCP Impersonated Account Counts in the current month.
`gcp_impersonated_max_account_count.previous_month_complete`	High watermark count of GCP Impersonated Account Counts in the previous month.
`gcp_roleset_max_count.current_month_estimate`	High watermark count of GCP rolesets in the current month.
`gcp_roleset_max_count.previous_month_complete`	High watermark count of GCP rolesets in the previous month.
`gcp_static_max_account_count.current_month_estimate`	High watermark count of GCP static accounts in the current month.
`gcp_static_max_account_count.previous_month_complete`	High watermark count of GCP static accounts in the previous month.
`kmip_enabled.current_month_estimate`	Indicates if KMIP was enabled in the current month.
`kmip_enabled.previous_month_complete`	Indicates if KMIP was enabled in the previous month.
`kmse_max_count.current_month_estimate`	High watermark count of KMSE keys in the current month.
`kmse_max_count.previous_month_complete`	High watermark count of KMSE keys in the previous month.
`kubernetes_dynamic_max_role_count.current_month_estimate`	High watermark count of Kubernetes dynamic roles in the current month.
`kubernetes_dynamic_max_role_count.previous_month_complete`	High watermark count of Kubernetes dynamic roles in the previous month.
`kv_max_count.current_month_estimate`	High watermark count of KV secrets in the current month.
`kv_max_count.previous_month_complete`	High watermark count of KV secrets in the previous month.
`ldap_dynamic_max_role_count.current_month_estimate`	High watermark count of LDAP dynamic roles in the current month.
`ldap_dynamic_max_role_count.previous_month_complete`	High watermark count of LDAP dynamic roles in the previous month.
`ldap_static_max_role_count.current_month_estimate`	High watermark count of LDAP static roles in the current month.
`ldap_static_max_role_count.previous_month_complete`	High watermark count of LDAP static roles in the previous month.
`mongodb_atlas_max_role_count.current_month_estimate`	High watermark count of MongoDB Atlas roles in the current month.
`mongodb_atlas_max_role_count.previous_month_complete`	High watermark count of MongoDB Atlas roles in the previous month.
`nomad_max_role_count.current_month_estimate`	High watermark count of Nomad roles in the current month.
`nomad_max_role_count.previous_month_complete`	High watermark count of Nomad roles in the previous month.
`normalized_certs_issued.current_month_estimate`	The duration-adjusted count of certificates issued by built-in PKI backends for the current month.
`normalized_certs_issued.previous_month_complete`	The duration-adjusted count of certificates issued by built-in PKI backends for the previous month.
`openldap_dynamic_max_role_count.current_month_estimate`	High watermark count of OpenLDAP dynamic roles in the current month.
`openldap_static_max_role_count.current_month_estimate`	High watermark count of OpenLDAP static roles in the current month.
`openldap_static_max_role_count.previous_month_complete`	High watermark count of OpenLDAP static roles in the previous month.
`rabbitmq_max_role_count.current_month_estimate`	High watermark count of RabbitMQ roles in the current month.
`rabbitmq_max_role_count.previous_month_complete`	High watermark count of RabbitMQ roles in the previous month.
`terraformcloud_max_role_count.current_month_estimate`	High watermark count of Terraform Cloud roles in the current month.
`terraformcloud_max_role_count.previous_month_complete`	High watermark count of Terraform Cloud roles in the previous month.
`third_party_plugin_count.current_month_estimate`	High watermark count of third-party plugins in the current month.
`third_party_plugin_count.previous_month_complete`	High watermark count of third-party plugins in the previous month.
`totp_max_count.current_month_estimate`	High watermark count of TOTP keys in the current month.
`totp_max_count.previous_month_complete`	High watermark count of TOTP keys in the previous month.
`transform_operation_count.current_month_estimate`	Number of Transform data protection API calls in the current month.
`transform_operation_count.previous_month_complete`	Number of Transform data protection API calls in the previous month.
`transit_operation_count.current_month_estimate`	Number of Transit data protection API calls in the current month.
`transit_operation_count.previous_month_complete`	Number of Transit data protection API calls in the previous month.

PKI certificate metrics

Metric	Description
`certcount.current_month_estimate`	Estimated number of certificates issued by built-in PKI backends in the current month.
`certcount.previous_month_complete`	Number of certificates issued by built-in PKI backends in the previous month.

Sample payload

{
  "version": 3,
  "id": "01KMJTGFKWE7FBWQZX6S4HVD11",
  "mode": "manual",
  "timestamp": "2026-03-25T15:41:16.284424Z",
  "snapshot_records": [
    {
      "snapshot_version": 3,
      "data": "<base64-encoded payload>",
      "checksum": "fnv64a:aa69fdcf3e4936e8",
      "signature": "177d3739ae52b47509c631f4ace7d6c323032808a94a4c066577353b3065418e",
      "license": {
        "id": "27022b08-e270-d272-de0d-04f9cfe06ea0",
        "issuer": "hashicorp",
        "customer": "f8259fbc-d288-1301-6e1d-63500d474fcb"
      },
      "decoded_snapshot": {
        "snapshot_version": 3,
        "id": "0001MW7XJ8W2X1765QRQ2K4AVV",
        "timestamp": "2026-03-25T10:50:48.19319-04:00",
        "schema_version": "3.7.0",
        "product": "vault",
        "process_id": "01KMJQM2FW1VWR4GXZ0HNMB2G7",
        "gauges": {
          "alicloud_dynamic_max_role_count.current_month_estimate": {
            "key": "alicloud_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "alicloud_dynamic_max_role_count.previous_month_complete": {
            "key": "alicloud_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "aws_dynamic_max_role_count.current_month_estimate": {
            "key": "aws_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "aws_dynamic_max_role_count.previous_month_complete": {
            "key": "aws_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "aws_static_max_role_count.current_month_estimate": {
            "key": "aws_static_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "aws_static_max_role_count.previous_month_complete": {
            "key": "aws_static_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "azure_dynamic_max_role_count.current_month_estimate": {
            "key": "azure_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "azure_dynamic_max_role_count.previous_month_complete": {
            "key": "azure_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "azure_static_max_role_count.current_month_estimate": {
            "key": "azure_static_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "azure_static_max_role_count.previous_month_complete": {
            "key": "azure_static_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "billing.ssh.normalized_certificates.current_month_estimate": {
            "key": "billing.ssh.normalized_certificates.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "billing.ssh.normalized_certificates.previous_month_complete": {
            "key": "billing.ssh.normalized_certificates.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "billing.ssh.otp.current_month_estimate": {
            "key": "billing.ssh.otp.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "billing.ssh.otp.previous_month_complete": {
            "key": "billing.ssh.otp.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "certcount.current_month_estimate": {
            "key": "certcount.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "certcount.previous_month_complete": {
            "key": "certcount.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "clientcount.current_month_estimate.type.acme_client": {
            "key": "clientcount.current_month_estimate.type.acme_client",
            "value": 0,
            "mode": "write"
          },
          "clientcount.current_month_estimate.type.entity": {
            "key": "clientcount.current_month_estimate.type.entity",
            "value": 0,
            "mode": "write"
          },
          "clientcount.current_month_estimate.type.nonentity": {
            "key": "clientcount.current_month_estimate.type.nonentity",
            "value": 0,
            "mode": "write"
          },
          "clientcount.current_month_estimate.type.secret_sync": {
            "key": "clientcount.current_month_estimate.type.secret_sync",
            "value": 0,
            "mode": "write"
          },
          "clientcount.previous_month_complete.type.acme_client": {
            "key": "clientcount.previous_month_complete.type.acme_client",
            "value": 0,
            "mode": "write"
          },
          "clientcount.previous_month_complete.type.entity": {
            "key": "clientcount.previous_month_complete.type.entity",
            "value": 0,
            "mode": "write"
          },
          "clientcount.previous_month_complete.type.nonentity": {
            "key": "clientcount.previous_month_complete.type.nonentity",
            "value": 0,
            "mode": "write"
          },
          "clientcount.previous_month_complete.type.secret_sync": {
            "key": "clientcount.previous_month_complete.type.secret_sync",
            "value": 0,
            "mode": "write"
          },
          "consul_max_role_count.current_month_estimate": {
            "key": "consul_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "consul_max_role_count.previous_month_complete": {
            "key": "consul_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "database_dynamic_max_role_count.current_month_estimate": {
            "key": "database_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "database_dynamic_max_role_count.previous_month_complete": {
            "key": "database_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "database_static_max_role_count.current_month_estimate": {
            "key": "database_static_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "database_static_max_role_count.previous_month_complete": {
            "key": "database_static_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "gcp_impersonated_max_account_count.current_month_estimate": {
            "key": "gcp_impersonated_max_account_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "gcp_impersonated_max_account_count.previous_month_complete": {
            "key": "gcp_impersonated_max_account_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "gcp_roleset_max_count.current_month_estimate": {
            "key": "gcp_roleset_max_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "gcp_roleset_max_count.previous_month_complete": {
            "key": "gcp_roleset_max_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "gcp_static_max_account_count.current_month_estimate": {
            "key": "gcp_static_max_account_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "gcp_static_max_account_count.previous_month_complete": {
            "key": "gcp_static_max_account_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "kmip_enabled.current_month_estimate": {
            "key": "kmip_enabled.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "kmip_enabled.previous_month_complete": {
            "key": "kmip_enabled.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "kmse_max_count.current_month_estimate": {
            "key": "kmse_max_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "kmse_max_count.previous_month_complete": {
            "key": "kmse_max_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "kubernetes_dynamic_max_role_count.current_month_estimate": {
            "key": "kubernetes_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "kubernetes_dynamic_max_role_count.previous_month_complete": {
            "key": "kubernetes_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "kv_max_count.current_month_estimate": {
            "key": "kv_max_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "kv_max_count.previous_month_complete": {
            "key": "kv_max_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "ldap_dynamic_max_role_count.current_month_estimate": {
            "key": "ldap_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "ldap_dynamic_max_role_count.previous_month_complete": {
            "key": "ldap_dynamic_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "ldap_static_max_role_count.current_month_estimate": {
            "key": "ldap_static_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "ldap_static_max_role_count.previous_month_complete": {
            "key": "ldap_static_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "mongodb_atlas_max_role_count.current_month_estimate": {
            "key": "mongodb_atlas_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "mongodb_atlas_max_role_count.previous_month_complete": {
            "key": "mongodb_atlas_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "nomad_max_role_count.current_month_estimate": {
            "key": "nomad_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "nomad_max_role_count.previous_month_complete": {
            "key": "nomad_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "normalized_certs_issued.current_month_estimate": {
            "key": "normalized_certs_issued.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "normalized_certs_issued.previous_month_complete": {
            "key": "normalized_certs_issued.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "openldap_dynamic_max_role_count.current_month_estimate": {
            "key": "openldap_dynamic_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "openldap_static_max_role_count.current_month_estimate": {
            "key": "openldap_static_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "openldap_static_max_role_count.previous_month_complete": {
            "key": "openldap_static_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "rabbitmq_max_role_count.current_month_estimate": {
            "key": "rabbitmq_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "rabbitmq_max_role_count.previous_month_complete": {
            "key": "rabbitmq_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "terraformcloud_max_role_count.current_month_estimate": {
            "key": "terraformcloud_max_role_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "terraformcloud_max_role_count.previous_month_complete": {
            "key": "terraformcloud_max_role_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "third_party_plugin_count.current_month_estimate": {
            "key": "third_party_plugin_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "third_party_plugin_count.previous_month_complete": {
            "key": "third_party_plugin_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "totp_max_count.current_month_estimate": {
            "key": "totp_max_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "totp_max_count.previous_month_complete": {
            "key": "totp_max_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "transform_operation_count.current_month_estimate": {
            "key": "transform_operation_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "transform_operation_count.previous_month_complete": {
            "key": "transform_operation_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          "transit_operation_count.current_month_estimate": {
            "key": "transit_operation_count.current_month_estimate",
            "value": 0,
            "mode": "write"
          },
          "transit_operation_count.previous_month_complete": {
            "key": "transit_operation_count.previous_month_complete",
            "value": 0,
            "mode": "write"
          },
          // Product usage metrics. If opted out of product usage telemetry,
          // only default values (e.g. "0") are included.
        },
        "product_version": "2.0.0+ent",
        "license_id": {
          "id": "27022b08-e270-d272-de0d-04f9cfe06ea0",
          "issuer": "hashicorp",
          "customer": "f8259fbc-d288-1301-6e1d-63500d474fcb"
        },
        "metadata": {
          "add_ons": "",
          "billing_start": "2026-03-19T00:00:00Z",
          "cluster_id": "25c0f66a-e4b4-a1e2-7fc9-58c00593541f",
          "development_cluster": "false",
          "edition": "",
          "issuer": "hashicorp",
          "license_expiration_time": "2027-03-18T00:00:00Z",
          "license_start_time": "2026-03-19T00:00:00Z",
          "license_termination_time": "2027-05-18T00:00:00Z",
          "retention_months": "48",
          "storage_type": "inmem"
        }
      }
    }
  ]
}