Reference
auth_by_license
Authorize the session using a license key.
auth_by_license
Authorize the current WebSocket session by activating or validating a license key.
- Type:
3 - Requires initialization: yes
- Requires authorization: no
Request and response example
auth_by_license
Authorize a session using a license key.
Request fields
| Field | Type | Required | Meaning |
|---|---|---|---|
id | uint64 | yes | Request id. |
license | string | yes | License key. |
Response fields
| Field | Type | Meaning |
|---|---|---|
id | uint64 | Your request id. |
license | string | License key (echo). |
levels | string[] | License levels/tags. |
comment | string | null | Optional internal note. |
ip_address | string | null | IP stored for this activation. |
time_left | int64 | See note below. |
status | int | Result status. |
time_left note
time_left is intended to represent seconds remaining, but when the server activates a previously inactive license inside the same call, the current implementation may return an absolute Unix timestamp (seconds since epoch) instead. If you need a single normalized representation, convert to expires_at on the client and compute seconds remaining yourself.
Common statuses
| Status | Meaning |
|---|---|
1 | ok |
100 | license_invalid |
101 | license_blacklisted |
102 | license_expired |
106 | license_paused |
110 | license_activations_limit_reached |
303 | sessions_quota_exceeded |
6 | internal_server_error |