Cancel the addresses of a batch that have not started
POST
/orchestrator/cancel/{idempotencyKey}
Removes from the queue every address that has not been picked up yet.
Addresses in processing are NOT interrupted: part of their energy may already be paid for. Cancel is best-effort on the remainder.
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
idempotencyKey*
Type
Requiredstring
Responses
How many addresses were removed from the queue (10005).
application/json
JSON "detail": { "code": 5003, "status": "failed", "msg": "string", "data": { } }
{
}