Batch progress
GET
/orchestrator/status/{idempotencyKey}
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
Query Parameters
address
Return data for a single address instead of the whole order.
Type
string
Example
"TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE"Pattern
"^T[1-9A-HJ-NP-Za-km-z]{33}$"Responses
State of the order and of every address in it.
application/json
JSON "detail": { "code": 10000, "status": "processing", "data": { "idempotencyKey": "string", "requestId": 0, "clientRequestId": "string", "summary": { "additionalProperties": 0 }, "items": [ { "deliveryKey": 0, "trackingId": "string", "receiveAddress": "TQn9Y2khEsLJW1ChVWFMSMeRDow5KcbLSE", "status": "string", "energy": { "requested": 0, "delegated": 0, "status": "string", "chunks": { "total": 0, "done": 0 }, "orderIds": [ "string" ], "hashes": [ "3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae" ] }, "activation": { "status": "string", "orderId": "string", "hash": "string" }, "bandwidth": { "status": "string", "orderId": "string", "amount": 0, "period": "string", "hashes": [ "3636f97dde244fca17cdc0b2cf7fd157a4b0de94d8fbd4c190d5378ba911dfae" ], "skipReason": "string" }, "attempts": 0, "startedAt": "string", "finishedAt": "string" } ] } }
{
}