.png)
List active transfers. A transfer is normally started while doing a import using the request body.
Overview
Transfer state
A transfer can be in one of the following states.
TRANSFERRING Data is currently being sent. WAITING The transfer is waiting to start. FINISHED All the data has been transferred. ABORTED The transfer has been aborted by the user. FAILED An error has occurred causing the transfer to fail. FINISHED_PART A piece of the data has been sent.
Priorities
Transfers are assigned bandwidth according to their priorities. A priority is an integer between 1 and 1000. Transfers with a higher priority value is prioritized over transfers with a lower priority value.
Managing transfers
List all transfers
GET /transfer Returns all transfers that are in a particular state. Query Parameters: state (string) – Transfer state of the transfers to retrieve. Default is TRANSFERRING. number (integer) – The number of transfers to return. Default is all transfers. first (integer) – The number of the first transfer to return. Default is 1. Produces: application/xml, application/json – A TransferListDocument text/plain – CRLF-delimited list of transfer ids Role: _transfer_read
Retrieve a transfer
GET /transfer/(transfer-id) Retrieves a specific transfer. Produces: application/xml, application/json – A TransferDocument Role: _transfer_read
Update the priority of a transfer
PUT /transfer/(transfer-id) Sets a new priority for a specific transfer. Query Parameters: transferPriority (integer) – Required. The desired priority. Role: _transfer_write