RCrclone
sync

Bidirectional sync

Changed on

Performs a bidirectional synchronisation between two paths, supporting safety checks and recovery options.

post/sync/bisync

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.

dryRunboolean

Set to true to simulate the bisync run without making changes. Setting it to false doesn't turn off a dry run that the global config asks for.

resyncboolean

Set to true to perform a one-time resync, rebuilding bisync history.

checkAccessboolean

Set to true to abort if RCLONE_TEST files are missing on either side.

checkFilenamestring

Override the access-check sentinel filename; defaults to RCLONE_TEST.

maxDeleteinteger

Largest percentage of files that may be deleted, from 0 to 100. The bisync run aborts if it would delete more.

maxDeleteRenamesAwareboolean

Set to true to leave tracked renames out of the maxDelete count. This needs TrackRenames set in _config.

forceboolean

Set to true to bypass the maxDelete safety check.

checkSync'true' | 'false' | 'only'
createEmptySrcDirsboolean

Set to true to mirror empty directories between the two paths.

removeEmptyDirsboolean

Set to true to remove empty directories during cleanup.

filtersFilestring

Path to an rclone filters file applied to both paths.

ignoreListingChecksumboolean

Set to true to ignore checksum differences when comparing listings.

resilientboolean

Set to true to allow retrying after certain recoverable errors.

workdirstring

Directory path used to store bisync working files.

noCleanupboolean

Set to true to keep bisync working files after completion.

backupDir1string
backupDir2string
comparestring
conflictLoserstring
conflictResolvestring
conflictSuffixstring
downloadHashboolean
maxLockstring
noSlowHashboolean
recoverboolean
resyncModestring
slowHashSyncOnlyboolean

Response

Bisync completed with session details.

outputstring required

Captured output from the bisync operation.

sessionstring required

Session name derived from the two filesystems.

workDirstring required

Absolute path to the bisync working directory.

basePathstring required

Base path for listing files.

listing1string required

Path to the Path1 listing file.

listing2string required

Path to the Path2 listing file.

logFilestring required

Path to the log file.

Changes