Sign in
Telemetry

Turn anonymous telemetry on or off

Changed on

Instance admins only. Persisted in the settings row, audit-logged as TELEMETRY_SETTING_UPDATED, and applied without a restart. When TEMPS_TELEMETRY forces telemetry off, the choice is still saved but has no effect until the variable is removed; the response says so via source = environment.

patch/settings/telemetry

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/settings/telemetry
  • Auth: HTTP bearer

Request body

enabledboolean required

Response

Setting saved; returns the new state

admin_preferenceboolean nullable

The admin's stored choice; null when nobody has chosen yet.

anonymous_idstring nullable

Random identifier events are reported under. Not derived from the host, domain or any account. null if the reporter could not start.

can_manageboolean required

Whether the caller may change the setting (instance admins only).

default_enabledboolean required

The built-in default that applies when nobody has chosen.

enabledboolean required

Whether this server is sending anonymous telemetry right now.

endpoint_hoststring nullable

Host events are sent to.

env_opted_outboolean required

TEMPS_TELEMETRY forces telemetry off on this server. The console cannot override it; remove the variable and restart to change.

env_varstring required

Name of the environment variable that forces telemetry off.

privacy_doc_urlstring required

Documentation of what is collected and what is never collected.

source'environment' | 'admin_setting' | 'default' | 'unavailable' required

What decided the current telemetry state.

temps_versionstring nullable

Version string stamped on every event.

Example response

{
  "endpoint_host": "telemetry.temps.sh",
  "env_var": "TEMPS_TELEMETRY",
  "events": [
    {
      "name": "deploy_succeeded"
    }
  ]
}

Changes