Free tier
POST
/{tenantId}/{productId}/free-tier Anonymous usage beacon for free-tier devices (no license key). Lets the dashboard count free-tier installs. Uses the common headers & path parameters.
Request body
Section titled “Request body”| Field | Type | Required | Description |
|---|---|---|---|
instance_id | string | yes | A stable anonymous device id (≤128 chars) |
app_version / sdk_version / platform / sdk | string | no | Telemetry — recorded per device and shown on the dashboard’s Free-tier devices table. platform is the operating system (macos, windows, linux, ios, …), or the runtime (web, workers) where no OS applies; sdk is which SDK is reporting (swift, rust, js, csharp, cpp). sdk_version/platform/sdk are sent automatically by the SDKs; app_version is included only if you set it (e.g. the Rust SDK’s .app_version(…)). |
curl -X POST https://api.keylight.dev/acme/notes/free-tier \ -H "Content-Type: application/json" \ -H "X-Keylight-SDK-Key: $KEYLIGHT_SDK_KEY" \ -d '{ "instance_id": "device-abc123" }'await kl.reportFreeTier();Response (200)
Section titled “Response (200)”{ "received": true }Errors
Section titled “Errors”| Status | Condition |
|---|---|
400 | Missing / invalid body |
401 | Missing / invalid SDK key |
404 | Tenant not found |
429 | Quota / rate limit exceeded |