Cancel specific transfer
Cancels a scheduled or active transfer. Returns 400 in case the transfer is already completed, canceled or failed.
This operation requires space_cancel_replication privilege in case of canceling replication,
space_cancel_eviction privilege in case of canceling eviction and both of them when
canceling migration.
However, canceling your own transfers does not require any privileges.
Example cURL requests
Cancel specific transfer
curl -X DELETE -H "X-Auth-Token: $TOKEN" \
"https://$HOST/api/v3/oneprovider/transfers/$TRANSFER_ID"
Path parameters
| Parameter | Type & Description |
|---|---|
| tid required | string Transfer Id. |
Request Examples
oneprovider-rest-cli cancelTransfer tid=$TRANSFER_IDResponses
The transfer has been canceled.
Invalid request.
| Property | Type & Description |
|---|---|
error string Identifier representing internal error code. | |
error_description string Detailed error message. | |
Example
{
"error": "invalid_token",
"error_description": "Provided token could not be validated."
}Forbidden request.
| Property | Type & Description |
|---|---|
error string Identifier representing internal error code. | |
error_description string Detailed error message. | |
Example
{
"error": "invalid_token",
"error_description": "Provided token could not be validated."
}Transfer with provided Id was not found.
| Property | Type & Description |
|---|---|
error string Identifier representing internal error code. | |
error_description string Detailed error message. | |
Example
{
"error": "invalid_token",
"error_description": "Provided token could not be validated."
}Internal server error.
| Property | Type & Description |
|---|---|
error string Identifier representing internal error code. | |
error_description string Detailed error message. | |
Example
{
"error": "invalid_token",
"error_description": "Provided token could not be validated."
}