Rclone HTTP API
Download a file from the remote.
Download a file from the remote. The service will fetch the file and serve it in the response.
Create the config for a remote.
Create a new remote with name, type and options
Delete a remote in the config file.
Delete an existing remote
Dumps the config file.
Returns contents of the config file as JSON.
Get a remote in the config file.
Get a single remote in the config file.
Lists the remotes in the config file.
Returns a list of the remotes in the config file as an array.
Password the config for a remote.
Update the password for an existing remote
Shows how providers can be configured in the config file.
List in JSON format all the providers and show all config options.
Update the config for a remote.
Update options in an existing remote.
Set the bandwidth limit.
Set the bandwidth limit as a single entry or a pair of bandwidths in the format 'upload:download'
Returns list of groups.
Returns a list of group names.
Returns the memory statistics
Returns an object describing memory allocation.
Returns stats about current transfers.
Shows stats for all current transfers, including bytes, deletes, errors, transferTime, and more.
Delete stats group.
Deletes a stats group.
Reset stats.
This clears counters, errors and finished transfers for all stats
or specific stats group if group is provided.
Returns stats about completed transfers.
Returns stats about completed transfers, including name, size, errors, jobid and more.
Lists the IDs of the running jobs
Returns a list of jobids for all running jobs.
Reads the status of the job ID
Given a job ID, returns the status of the job including finished, duration, error, and more.
Stop the running job
Immediately stop a job in progress.
Return the space used on the remote
Lists the total, used and free space on a given remote.
Remove trashed files in the remote or path
Clean up the remote if possible. Empty the trash or delete old file versions. Not supported by all remotes.
Copy a file from source remote to destination remote
This takes the following parameters:- srcFs - a remote name
string e.g. "drive:"for the source - srcRemote - a path within that
remote e.g. "file.txt"for the source - dstFs - a remote name string
e.g. "drive2:"for the destination - dstRemote - a path within that
remote e.g. "file2.txt"for the destination
Copy the URL to the object
Download a URL's content and copy it to the destination without saving it in temporary storage.
Remove files in the path
Removes files in the path, without deleting the directory.
Remove the single file pointed to
Removes a single file based on the given remote name and path.
Return information about the remote
Returns information about the remote including features, hashes, metadata and more.
List the given remote and path in JSON format
Return the remote and path in JSON format.
Make a destination directory or container
Makes the path if it doesn't already exist.
Move a file from source remote to destination remote
If source:path is a file or directory then it moves it to a file or directory named dest:path. This can be used to rename files or upload single files to other than their existing name.
Create or retrieve a public link to the given file or folder.
Generates a public link to a file/folder, or retrieves an existing link.
Remove a directory or container and all of its contents
Remove a directory or container and all of its contents. See the [purge](/commands/rclone_purge/) command for more information.
Remove an empty directory or container
Remove an empty directory or container. See the [rmdir](/commands/rclone_rmdir/) command for more information.
Remove all the empty directories in the path
This API endpoint allows you to remove all the empty directories in the path specified.
Count the number of bytes and files in remote
Returns the total size and number of objects in the remote.
Give information about the supplied file or directory
Returns information about a given file or directory, which can be fine-tuned using the endpoint options.
Upload file using multipart/form-data
Allows users to upload a file or files by providing the destination remote and path and the file as a binary string. Each entry in the body represents a file to be uploaded.
List all the option blocks
Returns an array of all the option blocks.
Get all the global options
Returns an object where keys are option block names and values are
an object populated with the current option values.
Get the currently active config for this call
Returns an object with the keys "config"and "filter". The "config"
key contains the local config and the "filter"key contains the local
filters.
Set an option
Set the value for a given option block.
Perform bidirectonal synchronization between two paths.
Bisync provides a bidirectional cloud sync solution in rclone. It retains the Path1 and Path2 filesystem listings from the prior run. On each successive run it will:
- list files on Path1 and Path2, and check for changes on each side. Changes include New, Newer, Older, and Deleted files
- Propagate changes on Path1 to Path2, and vice-versa
Copy a directory from source remote to destination remote.
This operation copies a directory from the source remote to the destination remote.
Move a directory from source remote to destination remote
Moves the contents of the source directory to the destination directory. Rclone will error if the source and destination overlap and the remote does not support a server-side directory move operation.
sync a directory from source remote to destination remote
Sync the source to the destination, changing the destination only.
Doesn't transfer files that are identical on source and destination, testing by size and modification time or MD5SUM.
Destination is updated to match source, including deleting files if necessary (except duplicate objects).
If you don't want to delete files from destination, use a copy operation instead.
