/api/qmail/local/locker-pool/status
GETReport locker pool counts and wallet balance. Status-only — does not contact RAIDA. To replenish the pool see /api/qmail/raida/locker-pool/replenish.
Description
The QMail subsystem reserves "locker" coins for two purposes:
- Uploads — coins that act as opaque payment tokens when sending a message.
- Inbox fees — coins that satisfy the recipient's inbox fee.
This endpoint reports how many of each are available in the wallet right now, plus the overall wallet balance and a low_balance flag the UI can use to nudge the user to replenish.
Parameters
| Param | Type | Required | Description |
|---|---|---|---|
wallet_path | string | Yes | Wallet name (e.g. Default) or full path. Must exist. |
Response
{
"command": "locker-pool",
"success": true,
"upload_available": 12,
"inbox_fee_available": 38,
"wallet_balance": 114.5,
"low_balance": false
}| Field | Type | Description |
|---|---|---|
upload_available | int | Locker coins available for outgoing uploads. |
inbox_fee_available | int | Locker coins reserved for paying inbox fees. |
wallet_balance | number | Total wallet balance in CloudCoins. |
low_balance | bool | UI hint — true when the pool needs replenishment. |
Errors
| HTTP | Message |
|---|---|
| 400 | Invalid wallet_path |
| 404 | Wallet not found |
| 500 | Failed to get pool status |
Example
curl "http://localhost:8081/api/qmail/local/locker-pool/status?wallet_path=Default"Related
- /api/qmail/raida/locker-pool/replenish — Run a RAIDA-backed replenish.
- /api/qmail/local/inbox-fee — Compute the cost of a specific upload.