RCrclone
operations

Compare source and destination

Changed on

Compares source and destination trees, reporting matches, differences, and missing files.

post/operations/check

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.

downloadboolean

Set to true to read file contents during comparison instead of relying on hashes.

checkFileHashstring

Hash name to expect in the supplied SUM file, such as md5.

checkFileRemotestring

Path within checkFileFs to the checksum SUM file.

oneWayboolean

Set to true to only ensure that source files exist on the destination.

combinedboolean

Set to true to include a combined summary report in the response.

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 include matching files in the report.

differboolean

Set to true to include differing files in the report.

errorboolean

Set to true to include entries that encountered errors.

Response

Comparison summary from operations/check, including missing, matching, and differing files.

successboolean required

True when the check completes without differences or errors.

statusstring required

Human readable status string.

hashTypestring

Hash algorithm used for comparisons when applicable.

combinedstring[]

Combined summary lines when combined=true is requested.

missingOnSrcstring[]

Files present on the destination but missing from the source.

missingOnDststring[]

Files present on the source but missing from the destination.

matchstring[]

Files that matched on both sides.

differstring[]

Files that differed between source and destination.

errorstring[]

Entries that produced errors during the check.

Changes