latestOpenAPI 3.1.02026-08-19134182238.2 KB

823dcdb67c40

On-Prem Telemetry

Register signing secret for HMAC verification

Register an on-prem signing secret (opm_xxx) for HMAC verification.

Call once before sending telemetry (optional — the first batch auto-
registers). The secret is encrypted at rest. `cmp_` API keys are rejected:
the on-prem image generates its own `opm_` credential on start, so upgrade
the image rather than supplying one by hand.

**Required Headers:**
- `X-API-Key`: Your Compresr API key

**Body:**
- `signing_secret`: On-prem signing secret (`opm_xxx`)
- `instance_id`: Optional instance identifier
post/api/v1/telemetry/register

Headers

X-API-Keystring required

Request body

signing_secretstring required

On-prem signing secret (opm_xxx), generated by the on-prem image and sent automatically. cmp_ API keys are rejected.

instance_idstring nullable

Instance identifier

Response

Successful Response

successboolean required
messagestring required
user_idstring nullable