Reclaim bandwidth early
POST
/bandwidth/reclaim/{orderId}
Voluntary return of delegated bandwidth before the period ends. The rental charge is NOT refunded — reclaiming only frees the pool resource ahead of time.
Calling it twice is safe: the same hash is returned.
Authorizations
ApiKeyAuth
API key from the dashboard. Some Host Mode endpoints also accept the key as an api_key field in the request body — this is stated in the schema of the particular operation.
Type
API Key (header: X-API-KEY)
Parameters
Header Parameters
X-Real-IP*
An IP address from the key's whitelist. A request from an address outside the whitelist is rejected with 401.
Type
Requiredstring
Example
"203.0.113.10"Format
"ipv4"Path Parameters
orderId*
Type
Requiredstring
Responses
Bandwidth reclaimed, or already reclaimed earlier (10004).
application/json
JSON "detail": { "code": 10004, "status": "reclaimed", "msg": "Energy reclaimed", "data": { "orderId": "string", "reclaimHash": "3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae" } }
{
}