Skip to main content
PUT
Start Remote Rsync Copy

Authorizations

Authorization
string
header
required

API key must be provided in the Authorization header

Body

application/json
src_path
string

Filesystem path on the source to copy from.

Example:

"/workspace/data"

dst_path
string

Filesystem path on the destination to copy to.

Example:

"/workspace/data"

Response

200 - application/json

Returns {success: false, error: "invalid_args", msg: "Invalid src_path."} or "Invalid dst_path." when path validation fails.

success
boolean

True when operation was initiated or connection info returned

dst_port
integer

Destination port for local-to-instance copies

dst_addr
string

Destination IP address for local-to-instance copies

src_port
integer

Source port for instance-to-local copies

src_addr
string

Source IP address for instance-to-local copies

error
string

Error code if success is false

msg
string

Human-readable message