telemetry

Record CLI resource statistics

Changed on

Records resource count statistics for a CLI operation, including number of Helm charts, Kubernetes manifests, preflights, and support bundles. Also captures tool version information.

Note: Authentication required. Team and user information is extracted automatically from the Bearer token. This endpoint is accessible to all authenticated users, including read-only users, to ensure comprehensive telemetry collection.

post/cli/telemetry/stats

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/cli/telemetry/stats
  • Auth
    API key in header Authorization

Request body

commandstring required

Name of the CLI command

helm_chartsinteger

Number of Helm charts in the release

k8s_manifestsinteger

Number of Kubernetes manifests in the release

preflightsinteger

Number of preflight checks

support_bundlesinteger

Number of support bundle definitions

tool_versionsobject

Versions of tools used (e.g., helm, kubectl)

Example request

{
  "command": "release create",
  "helm_charts": 3,
  "k8s_manifests": 45,
  "preflights": 2,
  "support_bundles": 1,
  "tool_versions": {
    "helm": "3.12.0",
    "kubectl": "1.28.0"
  }
}

Response

CliTelemetryStatsResponse represents the response from recording stats

statusstring

Status indicator

Example response

{
  "status": "ok"
}

Changes