NInixopus
Telemetry

Track CLI installation event

Changed on

Track CLI installation event.

Auth: Required (bearer token). Scope: Organization-scoped in authenticated context. Side effects: May mutate server state.

post/api/v1/cli/telemetry

Request

  • Base URL
    http://:8080
  • URL
    http://:8080/api/v1/cli/telemetry
  • Auth
    none declared

Headers

Acceptstring

Request body */*

archstring required

CPU architecture. Valid values: amd64, arm64, unknown

durationinteger

Installation duration in seconds

errorstring nullable

Error message if installation failed

event_typestring required

Type of installation event

osstring required

Operating system identifier. Valid values: ubuntu, debian, centos, fedora, rhel, alpine, arch, opensuse, sles, amzn, ol, rocky, almalinux, raspbian, pop, mint, manjaro, kali, nixos, gentoo, void, slackware, clear-linux-os, unknown

versionstring required

Semantic version string (e.g. 1.2.3 or 1.2.3-beta.1)

Example request

{
  "duration": 120,
  "event_type": "install_success",
  "version": "1.0.0"
}

Response

Created

messagestring
statusstring

Changes

  • 09f18af670c4Revision changes
    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      the request property became required

    • breaking

      removed the success response with the status

    • warning

      the request property's maxLength was set to 200

    • warning

      the request property's max was set to 7200.00

    • warning

      the request property's min was set to 0.00

    • info

      api tag Telemetry added

    • info

      api tag api/v1/cli/telemetry removed

    • info

      added the success response with the status

  • 2beb810c5221Revision changes
    • info

      endpoint added