RcloneOauth start
Begin an rclone OAuth flow. Returns the provider authorize URL plus the rclone remote name that will be created on the target device upon successful callback.
Request Body
providerstring · requiredCatalog key — must be a registered OAuth provider (see
rcloneProviders.ts).deviceIdstring · requiredDevice the remote is configured on — the host whose rclone panel opened the flow. Must be owned by the caller and online.
Responses
Successful response
authUrlstring · requiredProvider's authorization URL — open in a popup.
remoteNamestring · requiredThe rclone remote name we'll create on success — frontend can pre-display it.
flowIdstring · requiredPoll
rcloneOauth.status({ flowId })for the outcome.
loopbackbooleanProvider uses rclone's own OAuth client, so the browser ends on a dead
http://127.0.0.1:53682/?code&statepage: the user pastes that address into the app, which callscompletewith its query.
RcloneOauth complete
Exchange an OAuth authorization code for tokens and write the resulting rclone remote to the target device.
Request Body
codestring · requiredAuthorization code from the provider's redirect.
statestring · requiredSigned state token — verified, replay-checked, and decoded server-side.
Responses
Successful response
remoteNamestring · requiredThe rclone remote name now configured on the target device.
providerstring · requiredCatalog provider key, echoed so the frontend can invalidate the right queries.
RcloneOauth status
Poll the outcome of an rclone OAuth flow.
Responses
Successful response
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: status | |
| type = object · requires: status | |
| type = object · requires: status | |
| type = object · requires: status, error |
statusconst · requiredConst value: pending