Skip to main content
DELETE
Cancel Remote Rsync Copy

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
dst_id
string

Instance ID of the rsync destination whose copy to cancel.

Example:

"12346"

Response

200 - application/json

Returns {success: false, error: "invalid_args", msg: "Invalid dst_id."} when the destination instance is invalid, or {success: false, error: "invalid_args", msg: "Remote instance does not have an open port"} when no path is available.

success
boolean

True when cancel command was sent

error
string

Error code if success is false

msg
string

Human-readable message