NOTE: If you want to upload/update file in an encrypted library, you should decrypt the library (https://download.seafile.com/published/web-api/v2.1/library-encryption.md#user-content-Decrypt%20Library) first.
GET https://cloud.seafile.com/api2/repos/{repo-id}/upload-link/?p=/upload-dir
Request parameters
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/upload-link/
Sample response
"http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3"
Errors
403 Permission denied.
500 Run out of quota
After getting the upload link, POST to this link for uploading files.
POST http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3
Request parameters
The following parameters and file contents should be encoded in Multipart/form-data format . Most http client libraries support it.
The following parameters are set in the URL:
1. If this parameter is not set, the file ids will be returned in a tab-separated string. New apps should set ret-json to 1.true to ask the server to index file content asynchronously after upload is finished. So that the client doesn't have to wait until the file indexing is completed, which can take some time. The request returns a task_id to check file indexing progress.Sample request without ret-json parameter
upload file to /path-in-seafile-repo/, if a file named 'test.txt' already exists in /path-in-seafile-repo/, replace it with the new file:
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F file=@local-folder/test.txt -F parent_dir=/path-in-seafile-repo/ -F replace=1 http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F file=@local-folder/test.txt -F parent_dir=/path-in-seafile-repo/ http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3
Sample response without ret-json parameter
adc83b19e793491b1c6ea0fd8b46cd9f32e592fc
Sample request with relative_path and ret-json** **
upload file to /path-in-seafile-repo/sub_path_1/sub_path_2/, Seafile will create sub_path_1/sub_path_2/ recursively if it does not exist:
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F file=@local-folder/test.txt -F file=@1.jpg -F parent_dir=/path-in-seafile-repo/ -F relative_path=sub_path_1/sub_path_2/ http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3?ret-json=1
Sample response with relative_path and ret-json** **
[
{
"name": "test.txt",
"id": "4ccd37916552e2943314027931edd0b45240be7c",
"size": 2987
},
{
"name": "1.jpg",
"id": "12e07dd00c124fa7ea3b645ff9fe183f73eab2a1",
"size": 1699246
}
]
Sample request with need_idx_progress=true** **
upload file to /path-in-seafile-repo/:
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F file=@local-folder/test.txt -F parent_dir=/path-in-seafile-repo/ http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3?need_idx_progress=true
Sample response with ?need_idx_progress=true
d319a3f4-40da-4d58-9d3f-07864061f633
Then use the task_id above to get the progress of file indexing.
Sample request get progress of file indexing
http://192.168.1.113:8082/idx_progress?task_id=d319a3f4-40da-4d58-9d3f-07864061f633
The request returns a JSON string, containing following information:
ret-json=1 is set. It's only set when status is 0 (indexing finished).Sample response
{
"indexed": 1244,
"total": 1244,
"status": 0,
"ret_json": "[{\"name\": \"seafile-license (1).txt\", \"id\": \"cb8d8eaa4e540d30550a26e399b1207ef798bc67\", \"size\": 1244}]"
}
Note
Errors
400 Bad request
403 Permission denied
440 Invalid filename
442 File size is too large
443 Out of quota
500 Internal server error
Refer to https://manual.seafile.com/deploy_pro/web_resumable_upload.html to learn more about web resumable upload.
Request parameters
Sample request
curl -v -H 'Authorization: Token e71c00e93af863ba9bcddb61a46bb4de11d713fc' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.113:8000/api/v2.1/repos/09b7d3c0-5f0d-49be-9318-7ca136f386cd/file-uploaded-bytes/?parent_dir=/&file_name=test.md"
Sample response
* Trying 192.168.1.113...
* Connected to 192.168.1.113 (192.168.1.113) port 8000 (#0)
> GET /api/v2.1/repos/09b7d3c0-5f0d-49be-9318-7ca136f386cd/file-uploaded-bytes/?parent_dir=/&file_name=test.md HTTP/1.1
> Host: 192.168.1.113:8000
> User-Agent: curl/7.50.1
> Authorization: Token e71c00e93af863ba9bcddb61a46bb4de11d713fc
> Accept: application/json; charset=utf-8; indent=4
>
* HTTP 1.0, assume close after body
< HTTP/1.0 200 OK
< Date: Fri, 01 Jun 2018 08:59:27 GMT
< Server: WSGIServer/0.1 Python/2.7.12+
< Content-Length: 26
< Content-Language: en
< Accept-Ranges: bytes
< Vary: Accept, Accept-Language, Cookie
< Allow: GET, HEAD, OPTIONS
< Content-Type: application/json; charset=utf-8; indent=4
<
{
"uploadedBytes": 0
* Closing connection 0
}
If the response has this header Accept-Ranges: bytes, means that Seafile server supports resumable upload file.
Errors
Same as getting upload link for uploading files.
Before starting a resumable upload, you should first get how much of the file has been uploaded before, and use it as the offset to start uploading.
Request parameters
Sample request
curl -v -H 'Authorization: Token e71c00e93af863ba9bcddb61a46bb4de11d713fc' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.113:8000/api/v2.1/repos/09b7d3c0-5f0d-49be-9318-7ca136f386cd/file-uploaded-bytes/?parent_dir=/path-in-seafile-repo/&file_name=test.md"
Sample response
File has not been uploaded before.
{
"uploadedBytes": 0
}
File has already been uploaded 149946368 bytes. If you want to continue uploading this file, upload it begin with 149946368 bytes.
{
"uploadedBytes": 149946368
}
Errors
Usually a large file is uploaded in many "chunks" with resumable upload. The chunk size can be chosen by the client app. The chunks are then uploaded one by one. After the last chunk is uploaded, the server will index the entire file and save it.
After getting the upload link and uploadedBytes, POST to this link for uploading the chunks.
POST http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3
Request parameters
The request parameters are the same as uploading a file. But two extra headers must be added in the request.
Content-Disposition: attachment; filename=\"filename.txt\" . When using resumable upload, the name of the file is no longer retrieved from the "file" field of the form. It's instead retrieved from a header.Note: unlike uploading an entire file, resumable upload can only support uploading a single file in each request.
Sample request
upload file to /path-in-seafile-repo/, if a file named 'test.txt' already exists in /path-in-seafile-repo/, replace it with the new file:
curl -H "Content-Range: bytes 149946368-150994943/1587609600" -H "Content-Disposition: attachment; filename=\"test.md\"" -F file=@test.md -F parent_dir=/path-in-seafile-repo/ -F replace=1 http://cloud.seafile.com:8082/upload-api/73c5d117-3bcf-48a0-aa2a-3f48d5274ae3
149946368-150994943 means is now uploading 149946368-150994943 bytes.1587609600 is file's total bytes.Sample response
If this is not the last chunk, the server returns 200 with
{
"success": true
}
If this is the last chunk, the server returns the same response as uploading an entire file.
Errors
400 Bad request
403 Permission denied
440 Invalid filename
442 File size is too large
443 Out of quota
500 Internal server error
GET https://cloud.seafile.com/api2/repos/{repo-id}/update-link/?p=/update-dir
Request parameters
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/update-link/
Sample response
"http://cloud.seafile.com:8082/update-api/e69e5ee7-9329-4f42-bf1b-12879bd72c28"
Errors
403 Permission denied.
500 Run out of quota
After getting the update link, POST to this link for updating files.
POST http://cloud.seafile.com:8082/update-api/e69e5ee7-9329-4f42-bf1b-12879bd72c28
Request parameters
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F file=@test.txt -F target_file=/test.txt http://cloud.seafile.com:8082/update-api/e69e5ee7-9329-4f42-bf1b-12879bd72c28
Returns
The id of the updated file
Sample response
"adc83b19e793491b1c6ea0fd8b46cd9f32e592fc"
Errors
400 Bad request
403 Permission denied
440 Invalid filename
441 File does not exist
442 File size is too large
443 Out of quota
500 Internal server error
Last modified by seafile, 2023-09-11