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 the config for a remote.
Delete a remote in the config file
Delete a remote in the config file.
Dumps the config file
Dumps the config file.
Get a remote in the config file
Get a remote in the config file.
Lists the remotes in the config file and defined in environment variables
Lists the remotes in the config file and defined in environment variables.
Password the config for a remote
Password the config for a remote.
Reads the config file path and other important paths
Reads the config file path and other important paths.
Shows how providers are configured in the config file
Shows how providers are configured in the config file.
Set the path of the config file
Set the path of the config file.
Update the config for a remote
Update the config for a remote.
Set the bandwidth limit
Set the bandwidth limit.
Returns disk usage of a locally attached disk
Returns disk usage of a locally attached disk.
Returns list of stats
Returns list of stats.
Returns the memory statistics
Returns the memory statistics
Returns stats about current transfers
Returns stats about current transfers.
Delete stats group
Delete 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.
Lists the IDs of the running jobs
Lists the IDs of the running jobs.
Reads the status of the job ID
Reads the status of the job ID
Stop the running job
Stop the running job
Stop all running jobs in a group
Stop all running jobs in a group.
Return the space used on the remote
Return the space used on the remote
Check the source and destination are the same
Check the source and destination are the same.
Remove trashed files in the remote or path
Remove trashed files in the remote or path
Copy a file from source remote to destination remote
This operation copies a file from a source remote to a destination remote.
It takes the following parameters:
- `srcFs`: A remote name string, e.g., `"drive:"` for the source.
- `srcRemote`: A path within the source remote, e.g., `"file.txt"`.
- `dstFs`: A remote name string, e.g., `"drive2:"` for the destination.
- `dstRemote`: A path within the destination remote, e.g., `"file2.txt"`.
Copy the URL to the object
Copy the URL to the object
Remove files in the path
Remove files in the path
Remove the single file pointed to
Remove the single file pointed to
Return information about the remote
Return information about the remote
Produces a hashsum file for all the objects in the path
This operation generates a hash file for all objects in the given path using the specified hash type.
The output is in the same format as the standard `md5sum`/`sha1sum` tool.
Parameters:
- `fs`: A remote name string, e.g., `"drive:"` for the source, `"/"` for local filesystem. This can point to a file, and just that file will be returned in the listing.
- `hashType`: The type of hash to be used, e.g., `"MD5"`, `"SHA1"`, etc.
- `download`: A flag to check by downloading rather than with hash (boolean).
- `base64`: A flag to output the hashes in base64 rather than hexadecimal (boolean).
If you supply the `download` flag, it will download the data from the remote and create the hash on the fly. This can be useful for remotes that don't support the given hash or if you want to check all the data.
**Note:** If you wish to supply a checkfile to check hashes against the current files, use `operations/check` instead of `operations/hashsum`.
Example:
```sh
$ rclone rc --loopback operations/hashsum fs=bin hashType=MD5 download=true base64=true
{
"hashType": "md5",
"hashsum": [
"WTSVLpuiXyJO_kGzJerRLg== backend-versions.sh",
"v1b_OlWCJO9LtNq3EIKkNQ== bisect-go-rclone.sh",
"VHbmHzHh4taXzgag8BAIKQ== bisect-rclone.sh"
]
}
```
List the given remote and path in JSON format
List the given remote and path in JSON format
Make a destination directory or container
Make a destination directory or container
Move a file from source remote to destination remote
This operation moves a file from a source remote to a destination remote.
It requires the following parameters:
- `srcFs`: A remote name string, e.g., `"drive:"` for the source, or `"/"` for local filesystem.
- `srcRemote`: A path within that remote, e.g., `"file.txt"`, representing the source file.
- `dstFs`: A remote name string for the destination, e.g., `"drive2:"`, or `"/"` for local filesystem.
- `dstRemote`: A path within that remote, e.g., `"file2.txt"`, representing the destination file.
Create or retrieve a public link to the given file or folder
Create or retrieve a public link to the given file or folder.
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.
Changes storage tier or class on all files in the path
This operation changes the storage tier or class for all files in the specified path.
It requires the following parameter:
- `fs`: A remote name string, e.g., `"drive:"`.
Changes storage tier or class on the single file pointed to
This operation changes the storage tier or class for a single file specified by the `remote` path on the provided remote `fs`.
It requires the following parameters:
- `fs`: A remote name string, e.g., `"drive:"`.
- `remote`: A path within that remote, e.g., `"dir"`, representing the specific file or directory whose storage tier will be changed.
Count the number of bytes and files in remote
Count the number of bytes and files in remote
Give information about the supplied file or directory
Give information about the supplied file or directory
Upload file using multiform/form-data
Upload file using multiform/form-data
List all the option blocks
List all the option blocks
Get all the global options
Returns an object where keys are option block names and values are an object with the current option values in.
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 an option
Perform bidirectional synchronization between two paths
Perform bidirectional synchronization between two paths.
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
Move a directory from source remote to destination remote
sync a directory from source remote to destination remote
sync a directory from source remote to destination remote
