v1

latestOpenAPI 3.1.0MIT2026-07-1799111346.8 KB

Bidirectional sync

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

post/sync/bisync

Query parameters

path1string

First remote directory, e.g. drive:path1.

path2string

Second remote directory, e.g. drive:path2.

dryRunboolean

Set to true to simulate the bisync run without making changes.

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.

maxDeletenumber

Abort the run if deletions exceed this percentage (default 50).

forceboolean

Set to true to bypass the maxDelete safety check.

checkSyncboolean

Controls final listing comparison; leave true for normal verification or set false to skip.

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.

backupdir1string

Backup directory on the first remote for changed files.

backupdir2string

Backup directory on the second remote for changed files.

noCleanupboolean

Set to true to keep bisync working files after completion.

_configstring

JSON encoded config overrides applied for this call only.

_filterstring

JSON encoded filter overrides applied for this call only.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

Headers

Prefer'respond-async'

Set to "respond-async" with _async=true to receive HTTP 202 instead of 200.

Request body

path1string

First remote directory, e.g. drive:path1.

path2string

Second remote directory, e.g. drive:path2.

dryRunboolean

Set to true to simulate the bisync run without making changes.

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.

maxDeletenumber

Abort the run if deletions exceed this percentage (default 50).

forceboolean

Set to true to bypass the maxDelete safety check.

checkSyncboolean

Controls final listing comparison; leave true for normal verification or set false to skip.

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.

backupdir1string

Backup directory on the first remote for changed files.

backupdir2string

Backup directory on the second remote for changed files.

noCleanupboolean

Set to true to keep bisync working files after completion.

_configstring

JSON encoded config overrides applied for this call only.

_filterstring

JSON encoded filter overrides applied for this call only.

_groupstring

Assign the request to a custom stats group.

_asyncboolean

Run the command asynchronously. Returns a job id immediately.

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.