Cloudreve API Docs
Upload
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
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
Send reset password email
Reset password via temp link
Get profile picture
Get user
List user's share links
Get storage capacity
Search user
List credit changes
List payments
Callback
Complete OBS upload
Complete OneDrive upload
Complete COS upload
Complete S3 upload
Workflow
Remote Download
Create remote download
Select files to download
Cancel task
List tasks
Get task progress
Create archive
Extract archive
Relocate storage policy
Import external files
File
Permission
Set permission
Delete permission setting
Upload
Create upload session
PUT
Upload file chunk
POST
Delete upload session
DELETE
Pin
Pin to sidebar
Delete a pin
Version
Set file version
Delete file version
Direct Link
Create direct links
Delete direct link
List files
GET
List file activities
GET
Get file info
GET
Get thumbnail URL
GET
Update file content
PUT
Create viewer session
PUT
Create file
POST
Rename file
POST
Move or copy files
POST
Create download URL
POST
Restore from trash bin
POST
Delete file
DELETE
Force unlock
DELETE
Patch metadata
PATCH
Mount storage policy
PATCH
Update view setting
PATCH
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
Upload
Copy Page
Upload file chunk
POST
/file/upload/{sessionId}/{index}
Try it
Run in Apifox
Run in Apifox
Upload one chunk to Cloudreve. This method only applies to local storage policy, or storage policies with upload relay enabled.
If mulitpart upload is disabled, all file data should be send in one request with
index
set to
0
;
Chunks must be uploaded in order, starting from index
0
;
Content-Length
header is required.
Request
Authorization
Add the parameter
Authorization
to Headers
,whose value is to concatenate the Token after the Bearer.
Example:
Authorization: Bearer ********************
Path Params
Generate Code
Header Params
Generate Code
Body Params
application/octet-stream
Not configured
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
Responses
🟢
200
Success
application/json
Generate Code
Body
Generate Code
Example
{
"code"
:
0
,
"msg"
:
""
}
Modified atÂ
2025-08-12 07:13:02
Previous
Create upload session
Next
Delete upload session