RCrclone
sync

Move source to destination

Changed on

Moves objects from a source remote to a destination remote, optionally cleaning up empty directories. This can take a long time, so run it in the background with Prefer: respond-async to avoid HTTP timeouts.

post/sync/move

Request

Headers

Prefer'respond-async'

Set to respond-async to run the call in the background. Rclone returns a 202 with a job ID right away, and job/status reports progress. This has the same effect as the _async param in rclone's docs, but _async alone returns a 200 instead of a 202.

Request body

_configobject

Config overrides for this call only.

_filterobject

Filter overrides for this call only.

_groupstring

Stats group for this call.

combinedboolean

Set to true to return a combined report of the changes.

missingOnSrcboolean

Set to true to report files missing from the source.

missingOnDstboolean

Set to true to report files missing from the destination.

matchboolean

Set to true to report matching files.

differboolean

Set to true to report files that differ.

errorboolean

Set to true to report files that had errors while hashing or reading.

destAfterboolean

Set to true to report the files on the destination after the operation.

createEmptySrcDirsboolean

Set to true to create empty source directories on the destination.

deleteEmptySrcDirsboolean

Set to true to delete empty directories from the source after the move completes.

Response

An empty object, unless the request asked for reports. Then it holds one list of file paths for each report. If the call fails, the reports are only available when it ran in the background, in the job output.

combinedstring[]

Combined report lines. Each line is a symbol, a space and a path. = means identical, - missing on the source, + missing on the destination, * different and ! an error.

missingOnSrcstring[]

Files missing from the source.

missingOnDststring[]

Files missing from the destination.

matchstring[]

Files that matched on both sides.

differstring[]

Files that differed between source and destination.

errorstring[]

Files that had errors while hashing or reading.

destAfterstring[]

Files on the destination after the operation.

Changes

  • a7af46c0c706Revision changes
    • breaking

      added to the request body allOf list

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • 9abe65975575Revision changes
    • info

      api tag sync added