telemetry

Record CLI error details

Changed on

Records detailed error information for a CLI command that failed. The event_id must reference a valid event from cli_telemetry_events table, otherwise a 400 error is returned.

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

Request

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

Request body

commandstring required

Command that failed

error_messagestring

Detailed error message

error_typestring

Type of error that occurred

event_idstring required

Event ID to link this error to (must be a valid event_id from cli_telemetry_events)

Example request

{
  "command": "release lint",
  "error_message": "Invalid YAML syntax in release manifest",
  "error_type": "ValidationError",
  "event_id": "550e8400-e29b-41d4-a716-446655440000"
}

Response

CliTelemetryErrorResponse represents the response from recording an error

statusstring

Status indicator

Example response

{
  "status": "ok"
}

Changes