REreplicated
telemetry

Record CLI command execution event

Changed on

Records telemetry data for a CLI command execution including exit code, duration, and environment metadata. Returns a unique event_id that can be used to correlate errors with this event.

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/event

Request

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

Request body

commandstring required

Name of the CLI command that was executed

duration_msinteger

Duration of command execution in milliseconds

event_idstring required

Unique identifier for the event (UUID format, must be generated by client)

exit_codeinteger

Exit code of the command execution

has_config_fileboolean

Whether a config file was present

Example request

{
  "command": "release create",
  "duration_ms": 5000,
  "event_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

CliTelemetryEventResponse represents the response from creating a telemetry event

event_idstring

Unique identifier for the event (UUID format)

Example response

{
  "event_id": "550e8400-e29b-41d4-a716-446655440000"
}

Changes