Block and unblock
Blocks the key in the loader — the customer can't log in until you unblock it. The time keeps running.
/keys/{user_id}/blockToken permission: Block keys keys:block
While blocked, the key can't log into the loader: the customer sees "Access is stopped." until you unblock it. The time keeps running — blocking doesn't freeze the key, it still expires on the usual date. It costs no credits.
To unblock, the same call on /unblock:
/keys/{user_id}/unblockToken permission: Block keys keys:block
Path parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
user_id | number | Yes | The key's user_id — it comes in the generation and in the key list. |
The call has no body.
Response
blocked tells how the key ended up, and blocked_by who blocked it: reseller (you) or support. Repeating the request is not an error: blocking a key that is already blocked returns blocked: true again. In the key list, the key shows blocked: true.
You can only unblock what you blocked. A key blocked by support or by the anti-fraud system (for example, for being used on several PCs) shows blocked_by: "support", and unblocking answers 403: only support can release it. Blocking that key again does not make it yours.
Errors
| HTTP | When |
|---|---|
401 | Missing, invalid, deleted or expired token. |
403 | The token lacks the Block keys permission, the key is not yours, it is a recording key (those are not blocked here), or — when unblocking — the key was blocked by support. |
404 | The key has no access in the store. |
422 | An old key that points to a store customer's account instead of a key account: blocking would stop their VIPs. Contact support. |
429 | Rate limit reached. See the limits. |