/usage/bundle endpoint reference

This endpoint provides a usage bundle. For more information about the product usage data structure and the specific metrics that Terraform Enterprise collects, refer to theTerraform Enterprise usage data reference.

GET /api/v1/usage/bundle

Sample request

curl \  --header "Authorization: Bearer $TOKEN" \  --request GET \  https://tfe.example.com:8443/api/v1/usage/bundle

Sample Response

{    "version": "2",    "mode": "automatic",    "timestamp": "2025-06-05T19:54:16.016366464Z",    "signature": "fdd077fa855d11aa855d11a855d11aa855d11a",    "checksum": 5193303679122559012,    "snapshots": [        {            "snapshot_version": 2,            "id": "0001XXXXXXGXXXRMXXXXXXXXXXXX",            "timestamp": "2025-04-10T00:00:04.386332246Z",            "schema_version": "2.0.0",            "product": "terraform",            "process_id": "0001XXXXXXGXXXRMXXXXXXXXXXXX",            "metrics": {                "workspacecount": {                    "key": "workspacecount",                    "value": 0,                    "mode": "write"                }            },            "product_version": "v202504-1",            "license_id": "b855d11a-2b6e-4b0c-8e3f-2a3e5d6b7f9c",            "checksum": 5193303679122559012,            "metadata": {}        }    ]}

Response Codes

System API Overview

This API is distinct from the regular Admin API and the Backup and Restore API, with its own authentication mechanism.

Authentication

Requests to the/api/v1/ping and/api/v1/usage/bundle endpoints must be authenticated with a bearer token generated specifically for them using thetfectl admin api-token generate command. For more information on the token creation, and management, refer to thetfectl documentation.

Use the HTTP HeaderAuthorization with the valueBearer <token>.

Rate Limiting

All System API endpoints are rate limited to 1 request per second per authentication token.

Port Configuration

By default, the System API is accessible on HTTPS port8443. This port can be configured through theTFE_ADMIN_HTTPS_PORT environment variable in your deployment configuration.

Refer toNetwork settings in the configuration reference for more information about network configuration.

Versioning

The System API is versioned under the/api/v1 prefix and is separate from the main Terraform Enterprise API.

For example, if the API endpoint documentation defines the path/ping then the full path is/api/v1/ping.

Related Resources

• Enable automated product usage reports - Instructions for configuring Terraform Enterprise to automatically send product usage data to HashiCorp
• Generate product usage report using the CLI - Instructions for generating product usage reports manually