2 min read
Cloudreve V4
Connect a Cloudreve V4 personal file space through its user API, with reads/writes, directory management, and quota reporting.
Adapter type: cloudreve. See Common configuration for mounting instructions.
Setup
- Set
base_urlto the Cloudreve V4 site URL without/api/v4. - Use
emailandpasswordfor normal login. Complete CAPTCHA or additional verification in the browser when required. - After browser login, find user
access_tokenandrefresh_tokenin the login/refresh response in Network tools or Local Storage. Map them totokenandrefresh_token. - Use a Cloudreve URI for
root:cloudreve://myfor personal files, or a subdirectory such ascloudreve://my/Documents.
Configuration
Provide at least one authentication method:
password,token, orrefresh_token.
| Field | Type | Required | Default | Description |
|---|---|---|---|---|
base_url | string | Yes | — | Full HTTP(S) service URL; use the site address or protocol endpoint described below. |
email | string | No | — | Login email for password authentication. |
password | password | No | — | Remote account password. |
token | password | No | — | User access token (Bearer), not an SDK key. |
refresh_token | password | No | — | User refresh token, which can be used on its own to obtain access. |
root | string | No | "cloudreve://my" | Cloudreve URI, such as cloudreve://my or cloudreve://my/Documents. |
timeout | number | No | 60 | Request or connection timeout in seconds. |
Example
This is a config object. In the admin form, fill the corresponding fields rather than pasting the whole object. Replace credential placeholders with your own values.
json
{
"base_url": "https://cloudreve.example.com",
"email": "[email protected]",
"password": "YOUR_PASSWORD",
"root": "cloudreve://my",
"timeout": 60
}
Behavior and limitations
- Supply at least email/password, a user access token, or a refresh token. Retain a refresh token for renewal when possible.
- This is the V4 adapter, separate from V3 APIs. It does not use an SDK key or expose anonymous share mode.
- Login/refresh tokens are saved to configuration. An access-token-only setup requires manual replacement or renewable credentials when it expires.
Troubleshooting
- 404: verify the server is V4, the site URL is correct, and the proxy allows
/api/v4. - 401 / CAPTCHA: complete browser verification and supply user tokens rather than an SDK key.
- Root must use cloudreve:// URI: use
cloudreve://myor a child URI rather than/Documentsalone.
References
External documentation provides service and authorization context. Use this page and the current Foxel adapter for configuration fields and limitations.