io.github.rclone-ui/rclone

Create remote configuration — Creates a new remote in `rclone.conf`, mirroring `rclone config create`.

Delete remote configuration — Removes an existing remote from `rclone.conf`.

Dump configuration — Returns the contents of the config file as a JSON object keyed by remote name.

Get remote configuration — Returns the key/value settings for a single remote.

List configured remotes — Returns the names of all remotes defined in the config file.

Update remote secrets — Sets obscured password fields for a remote configuration.

Show config paths — Returns the paths to the config file, cache directory, and temporary directory.

List backend providers — Returns metadata describing each supported storage provider.

Set config path — Points rclone at a specific `rclone.conf` file.

Unlock encrypted config — Unlocks the configuration file using the provided password.

Update remote configuration — Updates an existing remote with new parameter values.

Get or update bandwidth limits — Reads the current bandwidth limit or applies a new schedule string, just like `rclone rc core/bwlimit`.

Run an rclone command — Executes a standard rclone CLI command remotely and streams or returns its output.

List locally accessible paths — Returns a list of locally accessible paths including mount points, user directories, and removable volumes.

Report disk usage — Returns disk usage statistics for the supplied local directory (defaults to the cache dir).

Force garbage collection — Triggers Go's garbage collector to release unused memory.

List stats groups — Lists stats groups currently tracked by rclone.

Fetch runtime memory stats — Returns Go runtime memory statistics similar to `runtime.ReadMemStats`.

Obscure a clear string — Obscures a plain-text secret for inclusion in `rclone.conf`.

Return rclone PID — Returns the process ID of the running rclone instance.

Terminate rclone — Stops the rclone process, optionally supplying an exit code.

Current stats snapshot — Returns active transfer statistics including bytes transferred, speed, and error counts.

Delete stats group — Deletes the counters associated with a specific stats group.

Reset stats counters — Clears counters, errors, and finished transfers for the provided stats group or all groups.

List completed transfers — Returns up to 100 recently completed transfers for the requested stats group.

Report rclone version — Returns the running rclone version, build metadata, and Go runtime details.

Get remote quota — Returns storage quota and usage details for the remote, equivalent to `rclone about`.

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

Remove trashed files — Permanently removes trashed objects from the specified remote path.

Copy a single file — Copies one object from a source remote and path to a destination remote and path.

Copy from URL — Downloads a public URL and stores it at the requested remote path.

Delete objects in path — Deletes matching files and directories for the provided remote, honouring filters and config overrides.

Delete single file — Removes a specific object from the remote.

Describe remote capabilities — Returns backend features, hash support, metadata descriptions, and other info for the remote.

Generate hash sums — Produces a hash sum listing for files under the given path using the requested hash algorithm.

Hash a single file — Returns the hash of a single file using the specified hash algorithm.

List objects — Lists objects and directories for a remote path, returning the same fields as `rclone lsjson`.

Create directory — Creates the target directory or container if it does not exist.

Move a single file — Moves one object from a source remote and path to a destination remote and path.

Create or remove public link — Creates a share URL for an object or removes an existing link when `unlink=true`.

Purge directory — Deletes a directory or container and all of its contents.

Remove empty directory — Deletes an empty directory or container.

Remove empty directories — Deletes empty subdirectories beneath the specified path, optionally leaving the root.

Change storage tier — Updates the storage class or tier for every object in the specified remote path.

Change file storage tier — Updates the storage class or tier for a single object.

Count remote size — Reports total size, file count, and number of objects without size metadata.

Stat an object — Returns metadata for a single file or directory, mirroring `rclone lsjson` on one entry.

Upload files via multipart — Accepts multipart/form-data payloads and writes the uploaded files to the specified remote path.

Return a test error — Always returns an error response incorporating the supplied parameters, useful for testing error handling.

List RC commands — Returns metadata about every available RC command, including whether authentication is required.