Cloudreve API Docs
Site
Copy Page
Cloudreve API Docs
Site
Ping
GET
Get CAPTCHA
GET
Get site settings
GET
Report abuse
POST
Session
Token
Password sign-in
Finish sign-in with 2FA
Refresh Token
Sign out
OpenID
Prepare OpenID sign-in
Finish OpenID sign-in
Unlink OpenID
Passkey
Prepare Passkey sign-in
Finish Passkey sign-in
Prepare login
GET
User
Passkey
Prepare passkey registration
Finish passkey registration
Delete passkey
Setting
List available storage policies
List available nodes
Get preferences
Prepare enabling 2FA
Update preference setting
Update profile pricture
Sign up
POST
Send reset password email
POST
Reset password via temp link
PATCH
Get profile picture
GET
Get user
GET
List user's share links
GET
Get storage capacity
GET
Search user
GET
List credit changes
GET
List payments
GET
Callback
Complete OBS upload
POST
Complete OneDrive upload
POST
Complete COS upload
GET
Complete S3 upload
GET
Workflow
Remote Download
Create remote download
Select files to download
Cancel task
List tasks
GET
Get task progress
GET
Create archive
POST
Extract archive
POST
Relocate storage policy
POST
Import external files
POST
File
Permission
Set permission
Delete permission setting
Upload
Create upload session
Upload file chunk
Delete upload session
Pin
Pin to sidebar
Delete a pin
Version
Set file version
Delete file version
Direct Link
Create direct links
Delete direct link
List files
List file activities
Get file info
Get thumbnail URL
Update file content
Create viewer session
Create file
Rename file
Move or copy files
Create download URL
Restore from trash bin
Delete file
Force unlock
Patch metadata
Mount storage policy
Update view setting
Share
Create share link
Edit share link
Get share link info
List my share links
Delete share link
VAS
Payment
Create a payment
Get payment status
GiftCode
Check gift code
Redeem gift code
Group
List groups
WebDAV
List accounts
Create account
Update account
Delete account
Site
Copy Page
Ping
GET
/site/ping
Try it
Run in Apifox
Run in Apifox
Get the version of the instance.
Request
None
Request Code Samples
Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request
Request Example
Shell
JavaScript
Java
Swift
cURL
cURL-Windows
Httpie
wget
PowerShell
curl
--location
--request
GET
'/site/ping'
Responses
🟢
200
OK
application/json
Generate Code
Body
Generate Code
Example
{
"data"
:
"4.0.0-alpha.1-pro"
,
"code"
:
0
,
"msg"
:
""
}
Modified atÂ
2025-08-12 07:13:02
Next
Get CAPTCHA