Web API (For Seafile server v5.1.0+)
-
Seafile Web API
- API Basics
- Status Code
- Quick Start
- Account
- Starred Files
- Group
-
Share
- Share Link
- Upload Link
-
Shared Libraries
- List User Shared Libraries
- List Group Shared Libraries
- List Be Shared Libraries
- Delete Be Shared Library
- Share a Library to User
- Unshare a Library from User
- Update Permission of User Shared Library
- Share a Library to Group
- Unshare a Library from Group
- Update Permission of Group Shared Library
- Batch Share Libraries to User
- Batch Share Libraries to Group
- Shared Folders
- Folder Permission
-
Library
- Get Default Library
- Create Default Library
- List Libraries
- Get Library Info
- Get Library Owner
- Get Library History
- Get Library History Limit Days
- Set Library History Limit Days
- Create Library
- Check/Create Sub Library
- Delete Library
- Rename Library
- Transfer Library
- Decrypt Library
- Create Public Library
- Set Exist Lib as Public Library
- Remove Public Library
- Fetch library download info
- Search Files in Libraries
- Get Library Download Links
- Get Library Upload Links
- Delete Library Download Link
- Delete Library Upload Link
- Search Library By Name
- File
- Directory
- Asynchronously Copy/Move File/Directory
- Multiple Files / Directories
- Avatar
- Devices
- Snapshot Label
- Get File Activities
- Get Thumbnail Image
- Search User
Seafile Web API
API Basics
All API calls must be authenticated with a valid Seafile API key.
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' https://cloud.seafile.com/api2/auth/ping/
The api key can be retrieved by the obtain auth api. See the Quick Start for details.
For each API, we provide curl examples to illustrate the usage. We also provide python and javascript examples, please refer to https://github.com/haiwen/webapi-examples for details.
Status Code
- 200: OK
- 201: CREATED
- 202: ACCEPTED
- 301: MOVED_PERMANENTLY
- 400: BAD_REQUEST
- 403: FORBIDDEN
- 404: NOT_FOUND
- 409: CONFLICT
- 429: TOO_MANY_REQUESTS
- 440: REPO_PASSWD_REQUIRED
- 441: REPO_PASSWD_MAGIC_REQUIRED
- 500: INTERNAL_SERVER_ERROR
- 520: OPERATION_FAILED
Quick Start
ping
curl https://cloud.seafile.com/api2/ping/
"pong"
obtain auth token
curl -d "[email protected]&password=123456" https://cloud.seafile.com/api2/auth-token/
{"token": "24fd3c026886e3121b2ca630805ed425c272cb96"}
you should use --data-urlencode if you want to process some special characters properly.
curl --data-urlencode [email protected] -d password=123456 https://cloud.seafile.com/api2/auth-token/
{"token":"265757b0a5aaf5d6b2e266d0c21791121ce6cdec"}
auth ping
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' https://cloud.seafile.com/api2/auth/ping/
"pong"
Account
Check Account Info
GET https://cloud.seafile.com/api2/account/info/
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/account/info/
Sample response
{
"usage": 26038531,
"total": 104857600,
"email": "[email protected]"
}
Errors
- 403 Invalid token
Get Server Information
GET https://cloud.seafile.com/api2/server-info
Note:
- No authentication required.
- Added in seafile community edition server
4.0.5or pro edition server4.0.3
Sample request
curl https://cloud.seafile.com/api2/server-info/
Sample response
Sample response from a seafile community edition server:
{
"version": "4.0.6",
"features": [
"seafile-basic",
]
}
Sample response from a seafile pro edition server:
{
"version": "4.0.6",
"features": [
"seafile-basic",
"seafile-pro",
"office-preview",
"file-search"
]
}
Starred Files
List starred files
GET https://cloud.seafile.com/api2/starredfiles/
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e6199b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/starredfiles/
Sample response
[
{
"repo": "99b758e6-91ab-4265-b705-925367374cf0",
"mtime": 1355198150,
"org": -1,
"path": "/foo/bar.doc",
"dir": false,
"size": 0
},
{
"repo": "99b758e6-91ab-4265-b705-925367374cf0",
"mtime": 1353751237,
"org": -1,
"path": "/add_folder-blue.png",
"dir": false,
"size": 3170
}
]
Star A File
POST https://cloud.seafile.com/api2/starredfiles/
Request parameters
- repo_id (post)
- p (post)
Sample request
curl -v -d "repo_id=dae8cecc-2359-4d33-aa42-01b7846c4b32&p=/foo.md" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/starredfiles/
Sample response
...
< HTTP/1.0 201 CREATED
< Location: https://cloud.seafile.com/api2/starredfiles/
...
"success"
Success
Response code is 201(Created) and Location header provides url of starred file list.
Errors
- 400
repo_idorpis missing, orpis not valid file path(e.g. /foo/bar/).
Unstar A File
DELETE https://cloud.seafile.com/api2/starredfiles/
Request parameters
- repo_id
- p
Sample request
curl -X DELETE -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' 'https://cloud.seafile.com/api2/starredfiles/?repo_id=dae8cecc-2359-4d33-aa42-01b7846c4b32&p=/foo.md'
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code is 200(OK), and a string named "success" is returned.
Errors
- 400
repo_idorpis missing, orpis not valid file path(e.g. /foo/bar/).
Group
List Groups
GET https://cloud.seafile.com/api2/groups/
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/groups/"
Sample response
{
"replynum": 0,
"groups": [
{
"ctime": 1398134171327948,
"creator": "[email protected]",
"msgnum": 0,
"mtime": 1398231100,
"id": 1,
"name": "lian"
},
{
"ctime": 1398236081042441,
"creator": "[email protected]",
"msgnum": 0,
"mtime": 0,
"id": 2,
"name": "123"
}
]
}
Add a Group
POST https://cloud.seafile.com/api/v2.1/groups/
Request parameters
- name (name of new group)
Sample request
curl -d "name=new_group_name" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/
Sample response
{
"name": "new_group_name",
"owner": "[email protected]",
"created_at": "2015-12-17T10:29:57+0800",
"admins": ["[email protected]"],
"avatar_url": "https://cloud.seafile.com/media/avatars/groups/default.png",
"id": 773
}
Get Info of a Group
GET https://cloud.seafile.com/api/v2.1/groups/772/
Request parameters
- avatar_size
- with_repos (0 or 1, if return library info of group. default 0 not return)
Sample request
curl -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/772/
Sample response
{
"name": "rename_group_name",
"owner": "[email protected]",
"created_at": "2015-12-17T10:29:57+0800",
"admins": ["[email protected]"],
"avatar_url": "https://cloud.seafile.com/media/avatars/groups/default.png",
"id": 772
}
Rename a Group
PUT https://cloud.seafile.com/api/v2.1/groups/772/
Request parameters
- name (name of new group)
Sample request
curl -X PUT -d "name=rename_group_name" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/772/
Sample response
{
"name": "rename_group_name",
"owner": "[email protected]",
"created_at": "2015-12-17T10:29:57+0800",
"admins": ["[email protected]"],
"avatar_url": "https://cloud.seafile.com/media/avatars/groups/default.png",
"id": 772
}
Transfer a Group
PUT https://cloud.seafile.com/api/v2.1/groups/772/
Request parameters
- owner (new owner of this group, should be an email.)
Sample request
curl -X PUT -d "owner=new_owner@new_owner.com" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/772/
Sample response
{
"name": "rename_group_name",
"owner": "new_owner@new_owner.com",
"created_at": "2015-12-17T10:29:57+0800",
"admins": ["[email protected]", "new_owner@new_owner.com"],
"avatar_url": "https://cloud.seafile.com/media/avatars/groups/default.png",
"id": 772
}
Delete a Group
DELETE https://cloud.seafile.com/api/v2.1/groups/772/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/772/
Sample response
{"success":true}
Quit Group
DELETE https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample response
{"success":true}
Group Member
List All Group Members
GET https://cloud.seafile.com/api/v2.1/groups/770/members/
Request parameters
- avatar_size
- is_admin (
trueorfalse, if ONLY return admin members of group. defaultfalsereturn all members)
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api/v2.1/groups/770/members/"
Sample response
[
{
"login_id": "",
"name": "nickname-of-lian",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": true,
"contact_email": "[email protected]",
"email": "[email protected]"
},
{
"login_id": "",
"name": "1",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
}
]
Add a Group Member
POST https://cloud.seafile.com/api/v2.1/groups/770/members/
Request parameters
Sample request
curl -d "[email protected]" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/
Sample response
{
"login_id": "",
"name": "new-member",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
}
Bulk Add Group Members
POST https://cloud.seafile.com/api/v2.1/groups/770/members/bulk/
Request parameters
- emails
Sample request
curl -d "[email protected],[email protected],[email protected]" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/bulk/
Sample response
{
"failed":[
{
"error_msg": "Invalid email",
"email": "[email protected]"
},
{
"error_msg": "Is already group member",
"email": "[email protected]"
}
"success":[
{
"login_id": "",
"name": "new-member-1",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
},
{
"login_id": "",
"name": "new-member-2",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
}
]
}
Get Info of a Group Member
GET https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample request
curl -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Request parameters
- avatar_size
Sample response
{
"login_id": "",
"name": "group-member",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
}
Set a Group Member Admin
PUT https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Request parameters
- is_admin=true
Sample request
curl -X PUT -d "is_admin=true" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample response
{
"login_id": "",
"name": "group-member",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": true,
"contact_email": "[email protected]",
"email": "[email protected]"
}
Unset a Group Member Admin
PUT https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Request parameters
- is_admin=false
Sample request
curl -X PUT -d "is_admin=false" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample response
{
"login_id": "",
"name": "group-member",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"is_admin": false,
"contact_email": "[email protected]",
"email": "[email protected]"
}
Delete a Group Member
DELETE https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/groups/770/members/[email protected]/
Sample response
{"success":true}
Group Message
Get Group Messages
GET https://cloud.seafile.com/api2/groups/{group_id}/discussions/
Request parameters
- group_id
- page (default 1)
- per_page (default 20)
- avatar_size (default 80)
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/groups/772/discussions/"
Sample response
{'current_page': 1,
'msgs': [{'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'content': u'test',
'created_at': '2016-07-11T09:18:20+08:00',
'group_id': 772,
'id': 1,
'user_email': u'[email protected]',
'user_login_id': '',
'user_name': u'name-of-lian'}],
'page_num': 1}
Send A Group Message
POST https://cloud.seafile.com/api2/groups/{group_id}/discussions/
Request parameters
- group_id
- content
- avatar_size (default 80)
Sample request
curl -d "content=this is another test" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/groups/772/discussions/"
Sample response
{'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'content': u'this is another test',
'created_at': '2016-07-11T09:27:49+08:00',
'group_id': 772,
'id': 3,
'user_email': u'[email protected]',
'user_login_id': '',
'user_name': u'name-of-lian'}
Delete A Group Message
DELETE https://cloud.seafile.com/api2/groups/772/discussions/3/
Request parameters
- group_id
- discuss_id
Sample request
curl -v -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/groups/772/discussions/3/"
sample response
...
< http/1.0 204 no content
...
Errors
- 400 Discussion id not found.
- 403 Permission denied.
Share
File Share Link
List all Share Links
This api will list all folder/file download share links in all libraries created by user.
GET https://cloud.seafile.com/api/v2.1/share-links/
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/share-links/"
Sample response
[
{
"username": "[email protected]",
"repo_id": "c474a093-19dc-4ddf-b0b0-72b33214ba33",
"ctime": "2017-04-01T02:35:57+00:00",
"expire_date": "",
"token": "6afa667ff2c248378b70",
"view_cnt": 0,
"link": "https://cloud.seafile.com/d/6afa667ff2c248378b70/",
"obj_name": "/",
"path": "/",
"is_dir": true,
"is_expired": false,
"repo_name": "seacloud.cc.124"
},
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:29+00:00",
"expire_date": "",
"token": "0c4eb0cb104a43caaeef",
"view_cnt": 0,
"link": "https://cloud.seafile.com/d/0c4eb0cb104a43caaeef/",
"obj_name": "folder",
"path": "/folder/",
"is_dir": true,
"is_expired": false,
"repo_name": "for-test-web-api"
},
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:35+00:00",
"expire_date": "",
"token": "8c05a00c44db4764b3a5",
"view_cnt": 0,
"link": "https://cloud.seafile.com/f/8c05a00c44db4764b3a5/",
"obj_name": "tmp.md",
"path": "/tmp.md",
"is_dir": false,
"is_expired": false,
"repo_name": "for-test-web-api"
}
]
Errors
- 403 Permission denied.
- 500 Internal Server Error
List Share Links of a Library
This api will list all folder/file download share links in a specific library.
GET https://cloud.seafile.com/api/v2.1/share-links/?repo_id={repo_id}
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/share-links/?repo_id=104f6537-b3a5-4d42-b8b5-8e47e494e4cf"
Sample response
[
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:29+00:00",
"expire_date": "",
"token": "0c4eb0cb104a43caaeef",
"view_cnt": 0,
"link": "https://cloud.seafile.com/d/0c4eb0cb104a43caaeef/",
"obj_name": "folder",
"path": "/folder/",
"is_dir": true,
"is_expired": false,
"repo_name": "for-test-web-api"
},
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:35+00:00",
"expire_date": "",
"token": "8c05a00c44db4764b3a5",
"view_cnt": 0,
"link": "https://cloud.seafile.com/f/8c05a00c44db4764b3a5/",
"obj_name": "tmp.md",
"path": "/tmp.md",
"is_dir": false,
"is_expired": false,
"repo_name": "for-test-web-api"
}
]
Errors
- 403 Permission denied.
- 404 library not found.
- 500 Internal Server Error
List Share Link of a Folder(File)
This api will list download share link info of a specific folder/file.
GET https://cloud.seafile.com/api/v2.1/share-links/?repo_id={rpeo_id}&path={path}
Request parameters
- repo-id
- path, could be path of a foler or a file.
Sample request
Get folder download share link.
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/share-links/?repo_id=104f6537-b3a5-4d42-b8b5-8e47e494e4cf&path=/folder/"
Sample response
[
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:29+00:00",
"expire_date": "",
"token": "0c4eb0cb104a43caaeef",
"view_cnt": 0,
"link": "https://cloud.seafile.com/d/0c4eb0cb104a43caaeef/",
"obj_name": "folder",
"path": "/folder/",
"is_dir": true,
"is_expired": false,
"repo_name": "for-test-web-api"
}
]
or a empty list [] if this folder has no download share link.
Get file download share link.
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/share-links/?repo_id=104f6537-b3a5-4d42-b8b5-8e47e494e4cf&path=/tmp.md"
Sample response
[
{
"username": "[email protected]",
"repo_id": "104f6537-b3a5-4d42-b8b5-8e47e494e4cf",
"ctime": "2017-04-01T02:35:35+00:00",
"expire_date": "",
"token": "8c05a00c44db4764b3a5",
"view_cnt": 0,
"link": "https://cloud.seafile.com/f/8c05a00c44db4764b3a5/",
"obj_name": "tmp.md",
"path": "/tmp.md",
"is_dir": false,
"is_expired": false,
"repo_name": "for-test-web-api"
}
]
or a empty list [] if this file has no download share link.
Errors
- 403 Permission denied.
- 404 folder/library not found.
- 500 Internal Server Error
Create Share Link
POST https://cloud.seafile.com/api/v2.1/share-links/
Request parameters
- repo-id
- path (file/folder path)
- password (not necessary)
- expire_days (not necessary)
Sample request
Create download link for file
curl -d "path=/foo.md&repo_id=62ca6cf9-dab6-47e5-badc-bab13d9220ce" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/share-links/
Create download link for directory with password and expire date
curl -d "path=/bar/&repo_id=62ca6cf9-dab6-47e5-badc-bab13d9220ce&password=password&expire_days=6" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/share-links/
Sample response
{
"username": "[email protected]",
"view_cnt": 0,
"ctime": "2016-03-04T04:06:35.477",
"token": "409f5aa54a",
"repo_id": "62ca6cf9-dab6-47e5-badc-bab13d9220ce",
"link": "https://cloud.seafile.com/f/409f5aa54a/",
"expire_date": null,
"path": "/foo.md",
"is_expired": false
}
{
"username": "[email protected]",
"view_cnt": 0,
"ctime": "2016-03-04T04:12:48.959",
"token": "db1a50e686",
"repo_id": "62ca6cf9-dab6-47e5-badc-bab13d9220ce",
"link": "https://cloud.seafile.com/d/db1a50e686/",
"expire_date": null,
"path": "/bar/",
"is_expired": false
}
Errors
- 400 path/repo_id invalid
- 403 Permission denied.
- 404 file/folder/library not found.
- 500 Internal Server Error
Delete Share Link
DELETE https://cloud.seafile.com/api/v2.1/share-links/{token}/
Sample request
curl -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api/v2.1/share-links/0ae587a7d1/"
Sample response
{"success":true}
Send Share Link Email
POST https://cloud.seafile.com/api2/send-share-link/
Request parameters
- token
- extra_msg (not necessary)
Sample request
curl -d "[email protected],invalid-email&token=4cbd625c5e" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/send-share-link/
Sample response
{
"failed": [
{
"email": "invalid-email",
"error_msg": "email invalid."
}
],
"success": [
"[email protected]"
]
}
Errors
- 400 token/repo_id invalid
- 403 Permission denied.
- 403 Sending shared link failed. Email service is not properly configured, please contact administrator.
- 404 token/library not found
List Direntry in Dir Download Link
GET https://cloud.seafile.com/api2/d/{token}/dir/
Request parameters
- token (upload link token)
- p (sub folder path)
- password (if link is encrypted)
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/d/3af7c46595/dir/?p=/subfolder/"
Sample response
[{"mtime": 1436846750, "type": "dir", "name": "sadof", "id": "1806dbdb700b7bcd49e6275107c7ccf7b3ea1776"}, {"id": "bdb06f6de972c42893fda590ac954988b562429c", "mtime": 1436431020, "type": "file", "name": "test.mdert", "size": 20}]
Upload Link
List Upload Links
GET https://cloud.seafile.com/api/v2.1/upload-links/
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api/v2.1/upload-links/"
Sample response
[{"username":"[email protected]","repo_id":"62ca6cf9-dab6-47e5-badc-bab13d9220ce","ctime":"2016-03-03T15:26:15.223","token":"9a5d5c8391","link":"https://cloud.seafile.com/u/d/9a5d5c8391/","path":"/"},{"username":"[email protected]","repo_id":"78c620ee-2989-4427-8eff-7748f4fbebc0","ctime":"2016-03-04T05:37:17.968","token":"d17d87ea4d","link":"https://cloud.seafile.com/u/d/d17d87ea4d/","path":"/yutong/"}]
Create Upload Link
POST https://cloud.seafile.com/api/v2.1/upload-links/
Request parameters
- repo-id
- path (file/folder path)
- password (not necessary)
Sample request
Create upload link for directory with password
curl -d "path=/bar/&repo_id=afc3b694-7d4c-4b8a-86a4-89c9f3261b12&password=password" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/upload-links/
Sample response
{
"username": "[email protected]",
"repo_id": "62ca6cf9-dab6-47e5-badc-bab13d9220ce",
"ctime": "2016-03-04T05:51:34.022",
"token": "dce40e8594",
"link": "https://cloud.seafile.com/u/d/dce40e8594/",
"path": "/bar/"
}
Errors
- 400 path/repo_id invalid
- 403 Permission denied.
- 500 Internal Server Error
Delete Upload Link
DELETE https://cloud.seafile.com/api/v2.1/upload-links/{token}/
Sample request
curl -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api/v2.1/upload-links/0ae587a7d1/"
Sample response
{"success":true}
Send Upload Link Email
POST https://cloud.seafile.com/api2/send-upload-link/
Request parameters
- token
- extra_msg (not necessary)
Sample request
curl -d "[email protected],invalid-email&token=4cbd625c5e" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/send-upload-link/
Sample response
{
"failed": [
{
"email": "invalid-email",
"error_msg": "email invalid."
}
],
"success": [
"[email protected]"
]
}
- 400 token/repo_id invalid
- 403 Permission denied.
- 403 Sending shared link failed. Email service is not properly configured, please contact administrator.
- 404 token/library not found
Shared Libraries
List User Shared Libraries
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
user
Sample request
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/&share_type=user
Sample response
[
{"user_info": {"nickname": "5", "name": "[email protected]"}, "share_type": "user", "permission": "r"},
{"user_info": {"nickname": "name of 4", "name": "[email protected]"}, "share_type": "user", "permission": "r"}
]
Errors
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
List Group Shared Libraries
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
group
Sample request
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/&share_type=group
Sample response
[
{"group_info": {"id": 65, "name": "group"}, "share_type": "group", "permission": "r"},
{"group_info": {"id": 395, "name": "lsd"}, "share_type": "group", "permission": "rw"}
]
Errors
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
List Be Shared Libraries
GET https://cloud.seafile.com/api2/beshared-repos/
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/beshared-repos/"
Sample response
"[{"user": "[email protected]", "repo_id": "989e3952-9d6f-4427-ab16-4bf9b53212eb", "share_type": "personal", "permission": "rw", "encrypted": false, "repo_desc": "lib shared to imwhatiam", "enc_version": false, "last_modified": 1398218747, "is_virtual": false, "group_id": 0, "repo_name": "lib shared to imwhatiam"}]"
Delete Be Shared Library
DELETE https://cloud.seafile.com/api2/beshared-repos/{repo_id}/?share_type=personal&[email protected]
Sample request
curl -X DELETE -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/beshared-repos/{repo_id}/?share_type=personal&[email protected]
Sample response
{"success": true}
Errors
- 400 Invalid argument
- 400 Library does not exist
Share a Library to User
PUT https://cloud.seafile.com/api2/repos/{repo_id}/dir/shared_items/?p=/
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
user - username, a email string or a list contains multi emails
- permission, default
r
Sample request
curl -X PUT -d "share_type=user&[email protected]&[email protected]&[email protected]&permission=r" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/
Sample response
{
"failed": [
{"email": "[email protected]", "error_msg": "User [email protected] not found."}
],
"success": [
{"user_info": {"nickname": "name of 4", "name": "[email protected]"}, "share_type": "user", "permission": "r"},
{"user_info": {"nickname": "5", "name": "[email protected]"}, "share_type": "user", "permission": "r"}
]
}
Errors
- 400 permission invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
Unshare a Library from User
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
user - username, a email string
Sample request
curl -X DELETE -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/&share_type=user&[email protected]"
Sample response
{"success": true}
Errors
- 400 share_type invalid.
- 400 email invalid.
- 403 Permission denied.
- 404 Library not found.
Update Permission of User Shared Library
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
user - username, a email string
- permisson,
rorrw
Sample request
curl -d "permission=r" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' "https://cloud.seafile.com/api2/repos/2deffbac-d7be-4ace-b406-efb799083ee9/dir/shared_items/?p=/&share_type=user&[email protected]"
Sample response
{"success": true}
Errors
- 400 share_type invalid.
- 403 permission invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
Share a Library to Group
PUT https://cloud.seafile.com/api2/repos/{repo_id}/dir/shared_items/?p=/
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
group - group_id , an integer or a list contains multi integers
- permission, default
r
Sample request
curl -X PUT -d "share_type=group&group_id=65&group_id=395&group_id=invalid_group_id&group_id=111&permission=rw" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/
Sample response
{
"failed": [],
"success": [
{"group_info": {"id": 65, "name": "group"}, "share_type": "group", "permission": "rw"},
{"group_info": {"id": 395, "name": "lsd"}, "share_type": "group", "permission": "rw"}
]
}
Errors
- 400 permission invalid.
- 400 group_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
Unshare a Library from Group
DELETE https://cloud.seafile.com/api2/repos/{repo_id}/dir/shared_items/?p=/&share_type=group&group=65
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
group - group_id , an integer
Sample request
curl -X DELETE -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/shared_items/?p=/&share_type=group&group_id=65"
Sample response
{"success": true}
Errors
- 400 share_type invalid.
- 400 group_id invalid.
- 403 Permission denied.
- 404 Library not found.
Update Permission of Group Shared Library
POST https://cloud.seafile.com/api2/repos/{repo_id}/dir/shared_items/?p=/&share_type=group&group_id=65
Request parameters
- p,
/means the root folder, which is equivalent to the library. - share_type,
group - group_id , an integer
- permisson,
rorrw
Sample request
curl -d "permission=r" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' "https://cloud.seafile.com/api2/repos/2deffbac-d7be-4ace-b406-efb799083ee9/dir/shared_items/?p=/&share_type=group&group_id=65"
Sample response
{"success": true}
Errors
- 400 share_type invalid.
- 403 permission invalid.
- 403 Permission denied.
- 404 Library not found.
Batch Share Libraries to User
POST https://cloud.seafile.com/api/v2.1/repos/batch/
Request parameters
- operation,
share - share_type,
user - username, email of a user
- permission, default is
rw - repo_id
Sample request
curl -d "operation=share&share_type=user&[email protected]&repo_id=b6cfa05d-07af-422b-924e-45202dc1cbb5&repo_id=48aa475d-deb0-40f0-ab9b-22ec84989a58" -H 'Authorization: Token 40c89d06a2beeec672d091156de4cc163c6aa31a' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api/v2.1/repos/batch/
Sample response
{
"failed": [
{"repo_id": "3761ade3-100b-4c3b-9508-79b3a510e6f6", "error_msg": "This item has been shared to [email protected]."}
],
"success": [
{"username": "[email protected]", "repo_id": "f820bd12-0511-4542-b14b-3e48d8efc294", "permission": "rw"}
]
}
Errors
- 400 permission invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 User not found.
- 500 Internal Server Error
Batch Share Libraries to Group
POST https://cloud.seafile.com/api/v2.1/repos/batch/
Request parameters
- operation,
share - share_type,
group - group_id
- permission, default is
rw - repo_id
Sample request
curl -d "operation=share&share_type=group&group_id=540&repo_id=b6cfa05d-07af-422b-924e-45202dc1cbb5&repo_id=48aa475d-deb0-40f0-ab9b-22ec84989a58" -H 'Authorization: Token 40c89d06a2beeec672d091156de4cc163c6aa31a' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api/v2.1/repos/batch/
Sample response
{
"failed": [
{"repo_id": "f820bd12-0511-4542-b14b-3e48d8efc294", "error_msg": "This item has been shared to group-of-lian."}
],
"success": [
{"permission": "rw", "repo_id": "3761ade3-100b-4c3b-9508-79b3a510e6f6", "group_id": 65, "group_name": "group-of-lian"}
]
}
Errors
- 400 permission invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Group not found.
- 500 Internal Server Error
Shared Folders
Share A Folder
PUT https://cloud.seafile.com/api2/repos/{repo-id}/dir/shared_items/?p={path}
- repo-id
- path
- permission,
rorrw - share_type,
userorgroup - username, necessary if share_type is user
- group_id, necessary if share_type is group
Sample request for share folder to user
curl -X PUT -d "[email protected]&share_type=user&permission=r" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/78c620ee-2989-4427-8eff-7748f4fbebc0/dir/shared_items/?p=/q
Sample response for share folder to user
{"failed": [], "success": [{"user_info": {"nickname": "2", "name": "[email protected]"}, "share_type": "user", "permission": "r"}]}
Sample request for share folder to group
curl -X PUT -d "group_id=772&share_type=group&permission=rw" -H 'Authorization: Token ef12bf1e66a1aa797a1d6556fdc9ae84f1e9249f' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/78c620ee-2989-4427-8eff-7748f4fbebc0/dir/shared_items/?p=/q
Sample response for share folder to group
{"failed": [], "success": [{"group_info": {"id": 772, "name": "group-2"}, "share_type": "group", "permission": "rw"}]}
Errors
- 400 share_type/permission/group_id invalid.
- 403 Permission denied.
- 404 Library/Folder/Group not found.
- 500 Failed to get sub repo.
List Shared Folders
GET https://cloud.seafile.com/api/v2.1/shared-folders/
Sample request
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/shared-folders/
Sample response
[
{
"share_permission": "rw",
"repo_id": "2deffbac-d7be-4ace-b406-efb799083ee9",
"share_type": "personal",
"folder_name": "asd",
"path": "/asd",
"user_name": "1",
"contact_email": "[email protected]",
"user_email": "[email protected]"
},
{
"share_permission": "r",
"repo_id": "2deffbac-d7be-4ace-b406-efb799083ee9",
"share_type": "group",
"group_name": "test_group",
"folder_name": "asd",
"path": "/asd",
"group_id": 1448
}
]
Errors
- 500 Internal Server Error
Update Shared Folder Permission
Sample request
curl -d "permission=r" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/2deffbac-d7be-4ace-b406-efb799083ee9/dir/shared_items/?p=/asd&share_type=user&[email protected]
Sample response
{"success":true}
Errors
- 400 permission invalid.
- 400 Email invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Unshare A Folder
Sample request
curl -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/2deffbac-d7be-4ace-b406-efb799083ee9/dir/shared_items/?p=/asd&share_type=group&group_id=1448
Sample response
{"success":true}
Errors
- 400 Email invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Folder Permission
User Folder Permission
Get User Folder Permission
GET http://192.168.1.124:8000/api2/repos/{repo_id}/user-folder-perm/?folder_path=/123
Request parameters
- repo_id
- folder_path
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/user-folder-perm/?folder_path=/123"
Sample response
[
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "r",
"folder_name": "123",
"user_name": "1",
"user_email": "[email protected]"
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "rw",
"folder_name": "123",
"user_name": "2",
"user_email": "[email protected]"
}
]
Errors
- 403 Permission denied.
- 404 Library not found.
Set User Folder Permission
POST http://192.168.1.124:8000/api2/repos/{repo_id}/user-folder-perm/
Request parameters
- repo_id
- folder_path
- user_email
- permission,
rorrw
Sample request
curl -d "folder_path=/123&permission=rw&[email protected]&[email protected]" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/user-folder-perm/"
Sample response
{
"failed": [
{
"error_msg": "Permission already exists.",
"user_email": "[email protected]"
}
],
"success": [
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "rw",
"folder_name": "123",
"user_name": "3",
"user_email": "[email protected]"
}
]
}
Errors
- 400 folder_path invalid.
- 400 permission invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
Modify User Folder Permission
PUT http://192.168.1.124:8000/api2/repos/{repo_id}/user-folder-perm/
Request parameters
- repo_id
- folder_path
- user_email
- permission,
rorrw
Sample request
curl -X PUT -d "folder_path=/123&permission=r&[email protected]" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/user-folder-perm/"
Sample response
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "r",
"folder_name": "123",
"user_name": "3",
"user_email": "[email protected]"
}
Errors
- 400 folder_path invalid.
- 400 permission invalid.
- 400 user_email invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 404 User not found.
- 404 Folder permission not found.
- 500 Internal Server Error
Delete User Folder Permission
DELETE http://192.168.1.124:8000/api2/repos/{repo_id}/user-folder-perm/
Request parameters
- repo_id
- folder_path
- user_email
Sample request
curl -X DELETE -d "folder_path=/123&[email protected]" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/user-folder-perm/"
Sample response
{
"success": true
}
Errors
- 400 user_email invalid.
- 400 folder_path invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 User not found.
- 500 Internal Server Error
Group Folder Permission
Get Group Folder Permission
GET http://192.168.1.124:8000/api2/repos/{repo_id}/group-folder-perm/?folder_path=/123
Request parameters
- repo_id
- folder_path
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/group-folder-perm/?folder_path=/123"
Sample response
[
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "rw",
"group_name": "group-2-of-lian",
"folder_name": "123",
"group_id": 586
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "r",
"group_name": "group-of-lian",
"folder_name": "123",
"group_id": 65
}
]
Errors
- 403 Permission denied.
- 404 Library not found.
Set Group Folder Permission
POST http://192.168.1.124:8000/api2/repos/{repo_id}/group-folder-perm/
Request parameters
- repo_id
- folder_path
- group_id
- permission,
rorrw
Sample request
curl -d "folder_path=/123&permission=rw&group_id=586&group_id=65" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/group-folder-perm/"
Sample response
{
"failed": [
{
"group_id": 65,
"error_msg": "Permission already exists."
}
],
"success": [
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "rw",
"group_name": "group-2-of-lian",
"folder_name": "123",
"group_id": 586
}
]
}
Errors
- 400 folder_path invalid.
- 400 permission invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
Modify Group Folder Permission
PUT http://192.168.1.124:8000/api2/repos/{repo_id}/group-folder-perm/
Request parameters
- repo_id
- folder_path
- group_id
- permission,
rorrw
Sample request
curl -X PUT -d "folder_path=/123&permission=rw&group_id=65" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/group-folder-perm/"
Sample response
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"folder_path": "/123",
"permission": "rw",
"group_name": "group-of-lian",
"folder_name": "123",
"group_id": 65
}
Errors
- 400 folder_path invalid.
- 400 permission invalid.
- 400 group_id invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 404 Group not found.
- 404 Folder permission not found.
- 500 Internal Server Error
Delete Group Folder Permission
DELETE http://192.168.1.124:8000/api2/repos/{repo_id}/group-folder-perm/
Request parameters
- repo_id
- folder_path
- group_id
Sample request
curl -X DELETE -d "folder_path=/123&group_id=65" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/group-folder-perm/"
Sample response
{
"success": true
}
Errors
- 400 group_id invalid.
- 400 folder_path invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Group not found.
- 500 Internal Server Error
Library
Get Default Library
GET https://cloud.seafile.com/api2/default-repo/
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/default-repo/"
Sample response
{
"repo_id": "691b3e24-d05e-43cd-a9f2-6f32bd6b800e",
"exists": true
}
Create Default Library
POST https://cloud.seafile.com/api2/default-repo/
Sample request
curl -X POST -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/default-repo/"
Sample response
{
"repo_id": "691b3e24-d05e-43cd-a9f2-6f32bd6b800e",
"exists": true
}
List Libraries
GET https://cloud.seafile.com/api2/repos/?type={type}
Request parameters
- type
mine, get my owned libraries.shared, get libraries shared to me.group, get group libraries.org, get public libraires.
NOTE: If no type parameter contained in the url, this api will return all libraries user can access.
Sample request for get all libraries I can accessed
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/
Sample response for get all libraries I can accessed
[
{
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-12T10:48:42\" is=\"relative-time\" title=\"Sat, 12 Aug 2017 10:48:42 +0800\" >1 minute ago</time>",
"mtime": 1502506122,
"owner": "[email protected]",
"root": "",
"id": "b8c8eeaf-a62f-4ece-a2cb-e1c67f49f881",
"size": 0,
"name": "group-lib",
"type": "repo",
"virtual": false,
"version": 1,
"head_commit_id": "b0a8c797972b83af1054428a397f843612257425",
"size_formatted": "0 bytes"
},
{
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-03T17:42:49\" is=\"relative-time\" title=\"Thu, 3 Aug 2017 17:42:49 +0800\" >8 days ago</time>",
"mtime": 1501753369,
"owner": "[email protected]",
"root": "",
"id": "cd0df3ce-7e1b-4fc3-9b76-714c48db47d7",
"size": 1449,
"name": "My Library",
"type": "repo",
"virtual": false,
"version": 1,
"head_commit_id": "9d47232bb87d39dbbba54fb8f09f9795b2d396e4",
"size_formatted": "1.4 KB"
},
{
"owner_nickname": "lian",
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-12T10:44:07\" is=\"relative-time\" title=\"Sat, 12 Aug 2017 10:44:07 +0800\" >6 minutes ago</time>",
"mtime": 1502505847,
"owner": "[email protected]",
"root": "",
"id": "c474a093-19dc-4ddf-b0b0-72b33214ba33",
"size": 708833229,
"name": "seacloud.cc.124",
"share_type": "personal",
"type": "srepo",
"version": 1,
"head_commit_id": "0b11fc08518d0c9acfd15e95a580664896484336",
"size_formatted": "676.0 MB"
},
{
"permission": "rw",
"encrypted": false,
"mtime": 1502506122,
"owner": "asdf",
"id": "b8c8eeaf-a62f-4ece-a2cb-e1c67f49f881",
"size": 0,
"name": "group-lib",
"root": "",
"version": 1,
"head_commit_id": "b0a8c797972b83af1054428a397f843612257425",
"type": "grepo",
"groupid": 1675
},
{
"share_from": "[email protected]",
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-12T10:33:47\" is=\"relative-time\" title=\"Sat, 12 Aug 2017 10:33:47 +0800\" >16 minutes ago</time>",
"mtime": 1502505227,
"owner": "Organization",
"root": "",
"id": "050ef344-45fb-49b6-80e6-e1bf094ab7bd",
"size": 0,
"name": "public-repo",
"share_type": "public",
"type": "grepo",
"version": 1,
"head_commit_id": "b71a95373896eb52e2971d72a869b7c413791b0b",
"size_formatted": "0 bytes"
}
]
Sample request for get my owned libraries
curl -H "Authorization: Token 8cc0e7085a24b6abfee721e758b6aab4a90e7321" -H 'Accept: application/json; indent=4' "http://192.168.1.124:8000/api2/repos/?type=mine"
Sample response for get my owned libraries
[
{
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-12T10:48:42\" is=\"relative-time\" title=\"Sat, 12 Aug 2017 10:48:42 +0800\" >19 minutes ago</time>",
"mtime": 1502506122,
"owner": "[email protected]",
"root": "",
"id": "b8c8eeaf-a62f-4ece-a2cb-e1c67f49f881",
"size": 0,
"name": "group-lib",
"type": "repo",
"virtual": false,
"version": 1,
"head_commit_id": "b0a8c797972b83af1054428a397f843612257425",
"size_formatted": "0 bytes"
},
{
"permission": "rw",
"encrypted": false,
"mtime_relative": "<time datetime=\"2017-08-03T17:42:49\" is=\"relative-time\" title=\"Thu, 3 Aug 2017 17:42:49 +0800\" >8 days ago</time>",
"mtime": 1501753369,
"owner": "[email protected]",
"root": "",
"id": "cd0df3ce-7e1b-4fc3-9b76-714c48db47d7",
"size": 1449,
"name": "My Library",
"type": "repo",
"virtual": false,
"version": 1,
"head_commit_id": "9d47232bb87d39dbbba54fb8f09f9795b2d396e4",
"size_formatted": "1.4 KB"
}
]
Get Library Info
GET https://cloud.seafile.com/api2/repos/{repo-id}/
Request parameters
- repo-id
Sample request
curl -G -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/632ab8a8-ecf9-4435-93bf-f495d5bfe975/
Sample response
{
"encrypted": false,
"password_need": null,
"mtime": null,
"owner": "self",
"id": "632ab8a8-ecf9-4435-93bf-f495d5bfe975",
"size": 1356155,
"name": "org",
"root": "b5227040de360dd22c5717f9563628fe5510cbce",
"desc": "org file",
"type": "repo"
}
Get Library Owner
GET https://cloud.seafile.com/api2/repos/{repo-id}/owner/
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/owner/
Sample response
{
"owner": "[email protected]"
}
Errors
- 403 Permission error(only administrator/repo-owner can perform this action).
Get Library History
GET https://cloud.seafile.com/api/v2.1/repos/{repo_id}/history/
Request parameters
- repo_id
- page, default 1
- per_page, default 100
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/history/"
Sample response
{
"data": [
{
"commit_id": "2b1313e4bbce2b938403c829b114b12b549128a3",
"time": "2017-04-10T03:24:09+00:00",
"description": "Recovered deleted directory \"456\"",
"creator": "[email protected]"
},
{
"commit_id": "0be8bba456ece31598557d9f3d5471b5b4d9d7c0",
"time": "2017-04-10T03:23:49+00:00",
"description": "Removed directory \"456\"",
"creator": "[email protected]"
},
{
"commit_id": "e6f21a80d60b7f1797434fdab622e562af937f81",
"time": "2017-04-10T03:23:45+00:00",
"description": "Deleted \"empty.docx\"",
"creator": "[email protected]"
},
{
"commit_id": "0bddb7401a75a9799209a24fb118e8d49151b6d6",
"time": "2017-04-10T03:23:41+00:00",
"description": "Deleted \"QQ_account_manager.png\"",
"creator": "[email protected]"
}
],
"more": false
}
Errors
- 403 Permission denied.
- 404 Library not found.
- 500 Internal Server Error
Get Library Trash
GET https://cloud.seafile.com/api/v2.1/repos/{repo_id}/trash/
Request parameters
- repo_id
- path, default '/'.
- per_page, default 100.
- scan_stat, An opaque status returned by the last call. In the first call, None must be passed. The last entry of the result list contains a 'scan_stat' attribute. In the next call, pass in the returned 'scan_stat'.
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/trash/"
Sample response
{
"scan_stat": "2b1313e4bbce2b938403c829b114b12b549128a3",
"data": [
{
"commit_id": "2364981a2bef50c16281a664df55af209019a88c",
"scan_stat": null,
"obj_id": "f86ef37332e89d6a132e27ce857c76e15971b227",
"deleted_time": "2017-04-10T03:23:41+00:00",
"obj_name": "QQ_account_manager.png",
"is_dir": false,
"parent_dir": "/",
"size": 77970
},
{
"commit_id": "0bddb7401a75a9799209a24fb118e8d49151b6d6",
"scan_stat": null,
"obj_id": "10ae7309338efe92d9ceddb9d6835463d277da34",
"deleted_time": "2017-04-10T03:23:45+00:00",
"obj_name": "empty.docx",
"is_dir": false,
"parent_dir": "/456/",
"size": 10682
}
...
],
"more": true
}
Get more trash items.
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/trash/?scan_stat=2b1313e4bbce2b938403c829b114b12b549128a3"
Sample response
{
"scan_stat": null,
"data": [
{
"commit_id": "726d2ce009df9176592ab88eca297b5e50c15639",
"scan_stat": null,
"obj_id": "cfc5e4299a862b366c98eeb7f5a8a1f689d2916a",
"deleted_time": "2017-04-10T09:11:02+00:00",
"obj_name": "empty.xlsx",
"is_dir": false,
"parent_dir": "/456/",
"size": 8176
},
{
"commit_id": "2b1313e4bbce2b938403c829b114b12b549128a3",
"scan_stat": null,
"obj_id": "414a75f5c67ca56c480ca2ae9137b7812940c3ce",
"deleted_time": "2017-04-10T09:11:01+00:00",
"obj_name": "empty.pptx",
"is_dir": false,
"parent_dir": "/456/",
"size": 40506
}
],
"more": false
}
Errors
- 403 Permission denied.
- 404 Library not found.
- 500 Internal Server Error
Get Library History Limit Days
GET https://cloud.seafile.com/api2/repos/{repo-id}/history-limit/
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/history-limit/
Sample response
{
"keep_days": -1,
}
Errors
- 403 Permission denied.
- 404 Library not found.
- 500 Internal Server Error
Set Library History Limit Days
PUT https://cloud.seafile.com/api2/repos/{repo-id}/history-limit/
Request parameters
- repo-id
- keep_days. -1 for keep full history; 0 for do not keep history; positive number for keep a period of limit days.
Sample request
curl -v -X PUT -d "keep_days=4" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/history-limit/
Sample response
{
"keep_days": 4,
}
Errors
- 400 keep_days invalid.
- 403 Permission denied.
- 404 Library not found.
- 500 Internal Server Error
- 520 Failed to set library history limit.
Create Library
POST https://cloud.seafile.com/api2/repos/
Request parameters
- name
- desc (defaults to "new repo")
- passwd (needed by encrypt library)
Sample request
curl -v -d "name=foo&desc=new library" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/
Sample response
{
"encrypted": "",
"enc_version": 0,
"repo_id": "f15811fd-5c19-412c-b143-2ac83f352290",
"magic": "",
"relay_id": "c5e41170db250ea497075e2911104faf0105b7fb",
"repo_version": 1,
"relay_addr": "cloud.seafile.com",
"token": "c1f3defe9ba408cd7964427ec276843e9d10c23b",
"relay_port": "10001",
"random_key": "",
"email": "[email protected]",
"repo_name": "foo"
}
Success
Response code 200 and newly created library information are returned.
Errors
- 400 Library name missing.
- 520 Operation failed.
Check/Create Sub Library
check if a dir has a corresponding sub_repo, if it does not have, create one
GET https://cloud.seafile.com/api2/repos/{repo-id}/dir/sub_repo/?p=/\&name=sub_lib
Request parameters
- repo-id
- p
- name
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/dir/sub_repo/?p=/\&name=sub_lib
Sample response
{"sub_repo_id": "c0a3283c-013c-4a7c-8f68-006f06fa6dec"}
Errors
- 400 Argument missing
- 500 INTERNAL SERVER ERROR
Delete Library
DELETE https://cloud.seafile.com/api2/repos/{repo-id}/
Sample request
curl -v -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/8f5f2222-72a8-454f-ac40-8397c5a556a8/
Sample response
"success"
Errors
400 Library does not exist.
403 Only library owner can perform this operation.
Rename Library
POST https://cloud.seafile.com/api2/repos/{repo-id}/?op=rename
Sample request
curl -d "repo_name=new-repo-name" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/8f5f2222-72a8-454f-ac40-8397c5a556a8/op=rename
Sample response
"success"
Errors
- 404 Library not found.
- 403 You do not have permission to rename this library.
- 500 Unable to rename library
Transfer Library
PUT https://cloud.seafile.com/api2/repos/{repo-id}/owner/
Request parameters
- repo-id
- owner
Sample request
curl -v -X PUT -d "[email protected]" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/owner/
Sample response
{
"success": True
}
Errors
- 440 Email invalid.
- 403 Permission error(only administrator/repo-owner can perform this action).
- 404 Library not found.
- 404 User not found.
Decrypt Library
POST https://cloud.seafile.com/api2/repos/{repo-id}/
Request parameters
- password
Sample request
curl -v -d "password=123" -H 'Authorization: Token e6a33d61954f219a96b60f635cf02717964e4385' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/0c2465a5-4753-4660-8a22-65abec9ec8d0/
Sample response
"success"
Errors
- 400 Incorrect password
- 409 Repo is not encrypt
- 500 Internal server error
Create Public Library
POST https://cloud.seafile.com/api2/repos/public/
Request parameters
- name
- permission,
rorrw, defaultr. - passwd (optional).
Sample request, create an encrypted public repo with rw permission
curl -X POST -d "name=test-public-repo&permission=rw&passwd=password" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/public/
Sample response
{
"owner_nickname": "lian",
"permission": "rw",
"encrypted": true,
"mtime_relative": "<time datetime=\"2016-05-31T12:01:49\" is=\"relative-time\" title=\"Tue, 31 May 2016 12:01:49 +0800\" >1 second ago</time>",
"mtime": 1464667309,
"owner": "[email protected]",
"id": "6553fd8b-bf3e-41ad-a481-90c8523d3b4a",
"size": 0,
"name": "test-public-repo",
"desc": "",
"size_formatted": "0 bytes"
}
Errors
- 400 Library name is required.
- 400 Invalid permission
- 403 You do not have permission to create library.
- 403 NOT allow to create encrypted library.
Set Exist Lib as Public Library
PUT https://cloud.seafile.com/api2/shared-repos/{repo-id}/?share_type=public
Request parameters
- repo_id
- share_type, must be
public - permission,
rorrw.
Sample request, create an encrypted public repo with rw permission
curl -X PUT -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api2/shared-repos/2deffbac-d7be-4ace-b406-efb799083ee9/?share_type=public&permission=rw'
Sample response
success
Errors
- 400 Permission need to be rw or r.
- 403 You do not have permission to share library.
- 500 Failed to share library to public.
Remove Public Library
DELETE https://cloud.seafile.com/api2/shared-repos/{repo-id}/?share_type=public
Request parameters
- repo-id
- share_type
Sample request
curl -X DELETE -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/shared-repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/?share_type=public
Success
"success"
Errors
- 400 Share type is required.
- 400 Share type can only be personal or group or public.
- 403 You do not have permission to unshare library.
Fetch library download info
GET https://cloud.seafile.com/api2/repos/{repo-id}/download-info/
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/download-info/
Sample response
{
"applet_root": "https://localhost:13420",
"relay_addr": "localhost",
"token": "46acc4d9ca3d6a5c7102ef379f82ecc1edc629e1",
"repo_id": "dae8cecc-2359-4d33-aa42-01b7846c4b32",
"relay_port": "10002",
"encrypted": "",
"repo_name": "test",
"relay_id": "8e4b13b49ca79f35732d9f44a0804940d985627c",
"email": "[email protected]"
}
Search Files in Libraries
GET https://cloud.seafile.com/api2/search/
Request parameters
q, keyword for searching.page, optional, a number greater than or equal to 1.per_page, optional.search_repo,all,mine,shared,group,publicor a repo_id, (allfor searching in all libraries, etc.), optional. For searching in shared libraries, you can also passshared_fromornot_shared_fromparameter besidesharedto filter shared libraries.search_path, path of specifiy library.(This option works only when search_repo is a single repo_id.)search_ftypes,allorcustom, (allfor searching all file types,customfor only searching the specific file types you defined inftypeandinput_fexts).ftype, must be in (Text,Document,Image,Video,Audio,PDF,Markdown).
TEXT: ('ac', 'am', 'bat', 'c', 'cc', 'cmake', 'cpp', 'cs', 'css', 'diff', 'el', 'h', 'html', 'htm', 'java', 'js', 'json', 'less', 'make', 'org', 'php', 'pl', 'properties', 'py', 'rb', 'scala', 'script', 'sh', 'sql', 'txt', 'text', 'tex', 'vi', 'vim', 'xhtml', 'xml', 'log', 'csv', 'groovy', 'rst', 'patch', 'go'),
DOCUMENT: ('doc', 'docx', 'ppt', 'pptx', 'odt', 'fodt', 'odp', 'fodp'),
IMAGE: ('gif', 'jpeg', 'jpg', 'png', 'ico', 'bmp', 'tif', 'tiff', 'eps'),
VIDEO: ('mp4', 'ogv', 'webm', 'mov'),
AUDIO: ('mp3', 'oga', 'ogg'),
PDF: ('pdf',),
MARKDOWN: ('markdown', 'md'),
input_fexts, file extensions manually specific.with_permission,trueorfalse. Whether return permission info of the file or not, default isfalse.
Sample request
curl -H 'Authorization: Token 076de58233c09f19e7a5179abff14ad55987350e' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api2/search/?q=seafile&search_repo=all&search_ftypes=custom&ftype=Document&input_fexts=md,png&per_page=3&page=3&with_permission=true"
Sample response
{
"has_more": true,
"total": 336,
"results": [
{
"repo_id": "040a8aad-5646-4c68-ba8a-73f90c60089f",
"name": "seafile \u8fd0\u7ef4.docx",
"permission": "r",
"oid": "ecba7db3d6b818873bf94cb1f2161f6a0fc22494",
"last_modified": 1482910730,
"content_highlight": "... .<b>seafile</b>.com...",
"fullpath": "/\u4e1c\u98ce\u65e5\u4ea7/Archived/seafile \u8fd0\u7ef4.docx",
"repo_name": "\u4ee3\u7ef4\u5ba2\u6237",
"is_dir": false,
"size": 494490
},
{
"repo_id": "233191c7-8e33-4fd2-b0a3-e480363d8e0d",
"name": "seafile-tutorial.doc",
"permission": "rw",
"oid": "1066014004ad479dd7f3cc0a12462c3f1fd2edeb",
"last_modified": 1389771193,
"content_highlight": "...A Brief Tour of <b>Seafile</b> <b>Seafile</b> is a file m...",
"fullpath": "/\u4ea7\u54c1\u4f7f\u7528\u6587\u6863/seafile-tutorial.doc",
"repo_name": "seafile-dev",
"is_dir": false,
"size": 414208
},
{
"repo_id": "233191c7-8e33-4fd2-b0a3-e480363d8e0d",
"name": "seafile_vm.md",
"permission": "rw",
"oid": "66c8dbe139333ead26b4878340da486fffdc5330",
"last_modified": 1439277140,
"content_highlight": "...<b>Seafile</b> server VM...",
"fullpath": "/\u90e8\u7f72\u548c\u8fd0\u7ef4/seafile_vm.md",
"repo_name": "seafile-dev",
"is_dir": false,
"size": 3255
}
]
}
Sample request
Search for files in a library specified directory.
curl -H 'Authorization: Token 076de58233c09f19e7a5179abff14ad55987350e' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api2/search/?q=a&search_repo=2628a63b-cfad-41f5-a748-392ec9287686&search_path=/testtest"
Sample response
{
"has_more": false,
"total": 2,
"results": [
{
"repo_owner_name": "admin",
"repo_id": "2628a63b-cfad-41f5-a748-392ec9287686",
"name": "3a",
"repo_owner_contact_email": "[email protected]",
"repo_owner_email": "[email protected]",
"last_modified": 1520836447,
"content_highlight": "",
"fullpath": "/testtest/3a",
"repo_name": "dev",
"is_dir": false,
"size": 0
},
{
"repo_owner_name": "admin",
"repo_id": "2628a63b-cfad-41f5-a748-392ec9287686",
"name": "1a",
"repo_owner_contact_email": "[email protected]",
"repo_owner_email": "[email protected]",
"last_modified": 1520836462,
"content_highlight": "",
"fullpath": "/testtest/1a",
"repo_name": "dev",
"is_dir": false,
"size": 0
}
]
}
Errors
- 404 Search not supported.
- 400 Missing argument q.
Get Library Download Links
GET https://cloud.seafile.com/api2/repos/{repo-id}/download-shared-links/
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/632ab8a8-ecf9-4435-93bf-f495d5bfe975/download-shared-links/
Sample response
[
{
"view_count": 0,
"name": "/",
"share_type": "d",
"creator_name": "lian",
"create_by": "[email protected]",
"token": "105f108fb6",
"create_time": "2016-01-18T15:03:10+0800",
"path": "/",
"size": ""
},
{
"view_count": 3,
"name": "1.md",
"share_type": "f",
"creator_name": "lian",
"create_by": "[email protected]",
"token": "a626012c1b",
"create_time": "2016-01-19T11:27:43+0800",
"path": "/1.md",
"size": "4"
}
]
Errors
- 403 Permission denied.
- 404 Library not found.
Get Library Upload Links
GET https://cloud.seafile.com/api2/repos/{repo-id}/upload-shared-links/
Request parameters
- repo-id
Sample request
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/632ab8a8-ecf9-4435-93bf-f495d5bfe975/upload-shared-links/
Sample response
[
{
"view_count": 3,
"name": "/",
"creator_name": "lian",
"create_by": "[email protected]",
"token": "43340efca5",
"create_time": "2016-01-18T15:03:12+0800",
"path": "/"
},
{
"view_count": 8,
"name": "a&b",
"creator_name": "lian",
"create_by": "[email protected]",
"token": "f1e49d445a",
"create_time": "2016-01-18T15:03:18+0800",
"path": "/a&b/"
}
]
Errors
- 403 Permission denied.
- 404 Library not found.
Delete Library Download Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/download-shared-links/{token}/
Request parameters
- repo-id
- token
Sample request
curl -X DELETE -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/632ab8a8-ecf9-4435-93bf-f495d5bfe975/download-shared-links/105f108fb6/
Sample response
{"success": true}
Errors
- 403 Permission denied.
- 404 Library not found.
- 404 Link not found.
Delete Library Upload Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/upload-shared-links/{token}/
Request parameters
- repo-id
- token
Sample request
curl -X DELETE -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/632ab8a8-ecf9-4435-93bf-f495d5bfe975/upload-shared-links/f1e49d445a/
Sample response
{"success": true}
Errors
- 403 Permission denied.
- 404 Library not found.
- 404 Link not found.
Search Library By Name
GET https://cloud.seafile.com/api2/repos/
Request parameters
- type (optional)
- nameContains (optional)
Sample request
Search the all library
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -sS 'https://cloud.seafile.com/api2/repos/?nameContains=T'
Sample response
[
{
"root": "",
"modifier_email": null,
"name": "TEST",
"permission": "rw",
"size_formatted": "424.6 MB",
"virtual": false,
"mtime_relative": "<time datetime=\"2017-07-04T08:30:33\" is=\"relative-time\" title=\"Tue, 4 Jul 2017 08:30:33 +0000\" >2017-07-04</time>",
"head_commit_id": "05418e616a5325b3f0ccfaf7d4c54c803b8168de",
"encrypted": false,
"version": 1,
"mtime": 1499157033,
"owner": "[email protected]",
"modifier_contact_email": "",
"type": "repo",
"id": "a9025464-2c72-4b9c-9cdd-6de62e56f696",
"modifier_name": "",
"size": 445243555
}
]
Sample request
Search the specified library
curl -H 'Authorization: Token 24fd3c026886e3121b2ca630805ed425c272cb96' -sS 'https://cloud.seafile.com/api2/repos/?type=mime&nameContains=T'
Sample response
[]
Errors
None
File
View File Through Owa
GET https://cloud.seafile.com/api2/repos/{repo-id}/owa-file/?path=/foo.docx
Request parameters
- repo-id
- path
- action,
vieworedit, default value isview;
Sample request for view
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' 'https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/owa-file/?path=/foo.docx'
Sample response for view
{
"access_token": "7decacff-6e55-4856-9734-01aaab26ef45",
"action_url": "http://off1.off.com/wv/wordviewerframe.aspx?WOPIsrc=http%3A%2F%2F192.168.1.124%3A8000%2Fapi2%2Fwopi%2Ffiles%2F2b0750085925fa85238e5f64cfd13ed6f1076bfd%2F",
"access_token_ttl": 1456906784000
}
Sample request for edit
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' 'https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/owa-file/?path=/foo.docx&action=edit'
Sample response for edit
{
"access_token": "bb80a7934b42454189ade73bdfba7f62",
"action_url": "http://off1.off.com/we/wordeditorframe.aspx?WOPISrc=http%3A%2F%2F192.168.1.227%3A8000%2Fapi2%2Fwopi%2Ffiles%2F1ef1da7af8dc2d02f85f156dba779a31ff1db9f7&ui=zh-CN&rs=zh-CN",
"access_token_ttl": 1496925674000
}
After get response
In order to instantiate the Office Online applications, a host must create an HTML page that will host an iframe element within it pointing to a particular WOPI action URL. And then use a form element and POST the access_token and access_token_ttl values to the Office Online.
For more info, you can see this official docs.
Errors
- 400 path invalid.
- 403 permission denied.
- 403 Library encrypted.
- 403 Office Web App feature not enabled.
- 403 Office Web App feature only supported in professional edition.
- 404 File/Library not found.
- 500 Internal Server Error
Download File
GET https://cloud.seafile.com/api2/repos/{repo-id}/file/?p=/foo
Request parameters
- repo-id
- p
- reuse (optional): Set
reuseto1if you want the generated download link can be accessed more than once in one hour.
Sample request
curl -v -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' 'https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/?p=/foo.c&reuse=1'
Sample response
"https://cloud.seafile.com:8082/files/adee6094/foo.c"
Errors
- 400 Path is missing
- 404 File not found
- 520 Operation failed.
Get File Detail
GET https://cloud.seafile.com/api2/repos/{repo-id}/file/detail/?p=/foo.c
- repo-id
- p
Sample request
curl -H 'Authorization: Token f2210dacd3606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/detail/?p=/foo.c
Sample response
{
"id": "013d3d38fed38b3e8e26b21bb3463eab6831194f",
"mtime": 1398148877,
"type": "file",
"name": "foo.py",
"size": 22
}
Errors
- 400 Path is missing
- 520 Operation failed.
Get File History
GET https://cloud.seafile.com/api2/repos/{repo-id}/file/history/?p=/foo.c
Request parameters
- repo-id
- p
Sample request
curl -H 'Authorization: Token f2210dacd3606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/history/?p=/foo.c
Sample response
{
"commits":
[
{
"rev_file_size": 0,
"repo_id": "a582d3bc-bcf5-421e-9125-741fa56d18d4",
"ctime": 1398149763,
"creator_name": "[email protected]",
"creator": "0000000000000000000000000000000000000000",
"root_id": "b64d413d9894c9206beac3faf9c2a0d75b4a8ebf",
"rev_renamed_old_path": null,
"parent_id": "8e546762e1657ab22dad83e9cb1e5ea31a767c9a",
"new_merge": false,
"version": 1,
"conflict": false,
"desc": "Added \"foo.c\"",
"id": "9464f7499bfa7363d563282361339eaf96a93318",
"rev_file_id": "0000000000000000000000000000000000000000",
"second_parent_id": null
},
{
"rev_file_size": 0,
"repo_id": "a582d3bc-bcf5-421e-9125-741fa56d18d4",
"ctime": 1398146059,
"creator_name": "[email protected]",
"creator": "0000000000000000000000000000000000000000",
"root_id": "572413414257c76039897e00aeb35f819471206b",
"rev_renamed_old_path": null,
"parent_id": "f977bdb0ebb205645c3b42216c2817e511c3f68f",
"new_merge": false,
"version": 1,
"conflict": false,
"desc": "Added \"foo.c\"",
"id": "a1ec20709675f4dc8db825cdbca296be245d189b",
"rev_file_id": "0000000000000000000000000000000000000000",
"second_parent_id": null
}
]
}
Errors
- 400 Path is missing
- 404 File not found
Restore File From History
POST https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/file/?p=/1.md
Request parameters
- repo_id
- p
- operation
- commit_id
Sample request
curl -d "operation=revert&commit_id=7ed3ccdc7559d1afddb95bc050230e3d54bbffef" -H "Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a" -H 'Accept: application/json; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/file/?p=/1.md"
Sample response
{
"success": true
}
Errors
- 400 commit_id invalid.
- 403 Permission denied.
- 403 File is locked
- 500 Internal Server Error
- 500 Check file lock error
Download File From a Revision
Request parameters
- repo-id
- p
- commit_id
Sample request
curl -H 'Authorization: Token f2210dacd3606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/revision/?p=/foo.c\&commit_id=a1ec20709675f4dc8db825cdbca296be245d189b
Sample response
"https://cloud.seafile.com:8082/files/adee6094/foo.c"
Errors
- 400 Path is missing
- 404 Revision not found
Create File
POST https://cloud.seafile.com/api/v2.1/repos/{repo_id}/file/?p={file_path}
Request parameters
- repo-id
- p
- operation
Sample request
curl -d 'operation=create' -H 'Authorization: Token c5de3074be40861f399f02c65149c6460bbf073f' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/file/?p=/test.xlsx"
Sample response
{
'is_locked': False,
'mtime': '2017-09-12T14:57:42+08:00',
'obj_id': u'44bdca6005429390d1ecc6943b05c821bd30917a',
'obj_name': u'test.xlsx',
'parent_dir': u'/',
'repo_id': u'7460f7ac-a0ff-4585-8906-bb5a57d2e118',
'size': 7631,
'type': 'file'
}
Errors
- 400 operation/name invalid.
- 400 operation can only be 'create', 'rename', 'move', 'copy' or 'revert'.
- 404 Library/Folder not found.
- 403 Permission denied.
- 500 Internal Server Error
Rename File
POST https://cloud.seafile.com/api2/repos/{repo-id}/file/?p=/foo.c
Request parameters
- repo-id
- p
- operation=rename
- newname
Sample request
curl -v -d "operation=rename&newname=newfoo.c" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/?p=/foo.c
Sample response
...
< HTTP/1.1 301 MOVED PERMANENTLY
...
"success"
Success
Response code is 301, and a string "success" is returned.
Errors
- 400 BAD REQUEST, Path is missing or invalid(e.g. p=/) or newname is missing(newname too long)
- 403 FORBIDDEN, You do not have permission to rename file
- 404 NOT FOUND, repo not found
- 409 CONFLICT, the newname is the same to the old
- 520 OPERATION FAILED, fail to rename file
Lock File
PUT https://cloud.seafile.com/api2/repos/{repo-id}/file/
Request parameters
- repo-id
- p
- operation
Sample request
curl -v -X PUT -d "operation=lock&p=/foo.c" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code is 200, and a string "success" is returned.
Errors
- 400 BAD REQUEST, Path is missing or invalid(e.g. p=/)
- 403 FORBIDDEN, You do not have permission to lock file
- 404 NOT FOUND, repo not found
- 520 OPERATION FAILED, fail to lock file
Unlock File
PUT https://cloud.seafile.com/api2/repos/{repo-id}/file/
Request parameters
- repo-id
- p
- operation
Sample request
curl -v -X PUT -d "operation=unlock&p=/foo.c" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code is 200, and a string "success" is returned.
Errors
- 400 BAD REQUEST, Path is missing or invalid(e.g. p=/)
- 403 FORBIDDEN, You do not have permission to lock file
- 404 NOT FOUND, repo not found
- 520 OPERATION FAILED, fail to unlock file
Move File
POST https://cloud.seafile.com/api2/repos/{repo-id}/file/?p=/foo.c
Request parameters
- repo-id
- p
- operation
- dst_repo
- dst_dir
Sample request
curl -v -d "operation=move&dst_repo=affc837f-7fdd-4e91-b88a-32caf99897f2&dst_dir=/123" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/?p=/foo.c
Sample response
...
< HTTP/1.1 301 MOVED PERMANENTLY
...
{
"repo_id": "affc837f-7fdd-4e91-b88a-32caf99897f2",
"parent_dir": "/123",
"obj_name": "foo.c"
}
Success
Response code is 301, and a string "success" is returned.
Errors
- 400 BAD REQUEST, Path is missing or invalid(e.g. p=/)
- 403 FORBIDDEN, You do not have permission to move file
- 404 NOT FOUND, repo not found
- 500 INTERNAL SERVER ERROR
Copy File
POST https://cloud.seafile.com/api2/repos/{repo-id}/file/?p=/foo.c
Request parameters
- repo-id
- p
- operation
- dst_repo
- dst_dir
Sample request
curl -v -d "operation=copy&dst_repo=73ddb2b8-dda8-471b-b7a7-ca742b07483c&dst_dir=/123" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/c7436518-5f46-4296-97db-2fcba4c8c8db/file/?p=/foo.c
Sample response
...
< HTTP/1.1 200 OK
...
{
"repo_id": "73ddb2b8-dda8-471b-b7a7-ca742b07483c",
"parent_dir": "/123",
"obj_name": "foo.c"
}
Success
Response code is 200, and a string "success" is returned.
Errors
- 400 BAD REQUEST, Path is missing or invalid(e.g. p=/)
- 403 FORBIDDEN, You do not have permission to copy file
- 500 INTERNAL SERVER ERROR
Revert File
PUT https://cloud.seafile.com/api2/repos/{repo_id}/file/revert/
Request parameters
- repo_id
- p
- commit_id
Sample request
curl -v -X PUT -d "commit_id=a1ec20709675f4dc8db825cdbca296be245d189b&p=/foo.c" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/8f5f2222-72a8-454f-ac40-8397c5a556a8/file/revert/
Sample response
...
< HTTP/1.0 200 OK
...
{"ret": 0}
Success
Response code 200(OK) is returned.
Errors
- 400 Path is missing
Delete File
DELETE https://cloud.seafile.com/api2/repos/{repo-id}/file/?p=/foo
Request parameters
- repo-id
- p
Sample request
curl -X DELETE -v -H 'Authorization: Token f2210dacd3606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/file/?p=/foo.c
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Errors
- 400 Path is missing
- 520 Operation failed.
Note
This can also be used to delete directory.
Upload File
Get Upload Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/upload-link/?p=/upload-dir
Request parameters
- repo-id
- p (use '/' as default)
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
Upload File
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
- file: local file path.
- parent_dir : path in your Seafile repo that you want to upload local file to.
- relative_path: sub path of "parent_dir", if this sub path does not exist, Seafile will create it recursively.
- ret-json: returns a json array including file info if set to
1.
NOTE:
parent_dirmust endswith/relative_pathmust NOT startswith/
Sample request
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
Sample response for no ret-json parameter
"adc83b19e793491b1c6ea0fd8b46cd9f32e592fc"
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 [email protected] -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 for with ?ret-json=1 parameter
[
{
"name": "test.txt",
"id": "4ccd37916552e2943314027931edd0b45240be7c",
"size": 2987
},
{
"name": "1.jpg",
"id": "12e07dd00c124fa7ea3b645ff9fe183f73eab2a1",
"size": 1699246
}
]
Note
New uploaded file name will be 'test(1).text' if a file with name 'test.txt' already exists in parent directory
For python client uploading, see https://github.com/haiwen/webapi-examples/blob/master/python/upload-file.py, or it can be done much more easily with elegant python requests library, see https://github.com/haiwen/webapi-examples/blob/master/python/upload-file2.py
Errors
400 Bad request
440 Invalid filename
500 Internal server error
Update file
Get Update Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/update-link/?p=/update-dir
Request parameters
- repo-id
- p (use '/' as default)
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
Update File
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
- target_file
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -F [email protected] -F filename=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
- 440 Invalid filename
- 500 Internal server error
Get Upload Blocks Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/upload-blks-link/
Request parameters
- repo-id
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/upload-blks-link/
Sample response
"https://cloud.seafile.com/seafhttp/upload-blks-api/569213db-7297-457a-907d-e2259a277c05"
Errors
- 403 Can not access repo
- 520 above quota
Get Update Blocks Link
GET https://cloud.seafile.com/api2/repos/{repo-id}/update-blks-link/
Request parameters
- repo-id
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/update-blks-link/
Sample response
"https://cloud.seafile.com/seafhttp/update-blks-api/402c6d48-fe52-4592-97dd-85f462f03d66"
Errors
- 403 Can not access repo
- 520 above quota
File Comments
Get Comment
GET https://cloud.seafile.com/api2/repos/{repo_id}/file/comments/{pk}/
- rpeo_id
- pk
Sample request
curl -H "Authorization: Token 05b05e30ee979e333ff33a437988820494fb0afd" https://cloud.seafile.com/api2/repos/4674c2bb-3702-4dd0-b768-8952db27ac87/file/comments/1/
Sample response
{
"comment": "welcome",
"repo_id": "4674c2bb-3702-4dd0-b768-8952db27ac87",
"item_name": "q",
"created_at": "2017-10-10T02:42:20+00:00",
"parent_path": "/",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"user_name": "admin",
"id": 3,
"user_email": "[email protected]",
"user_contact_email": "[email protected]"
}
Errors
- 400 Wrong comment id
- 403 Can not access repo
Delete Comment
Delete https://cloud.seafile.com/api2/repos/{repo_id}/file/comments/{pk}/
- rpeo_id
- pk
Sample request
curl -X DELETE -H "Authorization: Token 05b05e30ee979e333ff33a437988820494fb0afd" https://cloud.seafile.com/api2/repos/4674c2bb-3702-4dd0-b768-8952db27ac87/file/comments/1/
Sample response
None
Errors
- 400 Wrong comment id
- 403 Can not access repo
- 403 Permission denied
List Comments
GET https://cloud.seafile.com/api2/repos/{repo_id}/file/comments/?p=/doc/doc
- rpeo_id
- p
Sample request
curl -H "Authorization: Token 05b05e30ee979e333ff33a437988820494fb0afd" https://cloud.seafile.com/api2/repos/4674c2bb-3702-4dd0-b768-8952db27ac87/file/comments/?p=%2Fdoc%2Fdoc
Sample response
{
"comments": [
{
"comment": "word",
"repo_id": "4674c2bb-3702-4dd0-b768-8952db27ac87",
"item_name": "doc",
"created_at": "2017-10-11T02:49:42+00:00",
"parent_path": "/doc",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"user_name": "admin",
"id": 7,
"user_email": "[email protected]",
"user_contact_email": "[email protected]"
},
{
"comment": "help",
"repo_id": "4674c2bb-3702-4dd0-b768-8952db27ac87",
"item_name": "doc",
"created_at": "2017-10-11T02:49:44+00:00",
"parent_path": "/doc",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"user_name": "admin",
"id": 8,
"user_email": "[email protected]",
"user_contact_email": "[email protected]"
},
{
"comment": "test",
"repo_id": "4674c2bb-3702-4dd0-b768-8952db27ac87",
"item_name": "doc",
"created_at": "2017-10-11T03:32:37+00:00",
"parent_path": "/doc",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"user_name": "admin",
"id": 10,
"user_email": "[email protected]",
"user_contact_email": "[email protected]"
}
]
}
Errors
- 400 Wrong path
- 403 Can not access repo
Post Comments
POST https://cloud.seafile.com/api2/repos/{repo_id}/file/comments/?p=/doc/doc
- rpeo_id
- p
- comment
Sample request
curl -X POST -d "comment=hello" -H "Authorization: Token 05b05e30ee979e333ff33a437988820494fb0afd" https://cloud.seafile.com/api2/repos/4674c2bb-3702-4dd0-b768-8952db27ac87/file/comments/?p=%2Fdoc%2Fdoc
Sample response
{
"comment": "hello",
"repo_id": "4674c2bb-3702-4dd0-b768-8952db27ac87",
"item_name": "doc",
"created_at": "2017-10-11T06:43:31+00:00",
"parent_path": "/doc",
"avatar_url": "https://cloud.seafile.com/media/avatars/default.png",
"user_name": "admin",
"id": 11,
"user_email": "[email protected]",
"user_contact_email": "[email protected]"
}
Errors
- 400 Wrong path
- 400 Comment can not be empty
- 403 Can not access repo
- 404 File not found
- 500 Internal error
Get Number of Comments
GET https://cloud.seafile.com/api2/repos/{repo_id}/file/comments/counts/?p=/doc
- rpeo_id
- p
Sample request
get the number of file comment correspoding to the file under the folder
curl -H "Authorization: Token 05b05e30ee979e333ff33a437988820494fb0afd" -sS 'https://cloud.seafile.com/api2/repos/4674c2bb-3702-4dd0-b768-8952db27ac87/file/comments/counts/?p=/doc'
Sample response
[
{
"doc": 3
},
{
"pdfs": 1
}
]
Errors
- 400 Wrong path
- 403 Can not access repo
- 404 Folder not found
- 500 Internal error
Directory
List Directory Entries
GET https://cloud.seafile.com/api2/repos/{repo-id}/dir/
- repo-id
- p (optional): The path to a directory. If
pis missing, then defaults to '/' which is the top directory. - oid (optional): The object id of the directory. The object id is the checksum of the directory contents.
- t (optional): If set
targument asf, will only return file entries, anddfor only dir entries. - recursive (optional): If set
targument asdANDrecursiveargument as1, return all dir entries recursively
Sample request
request file/dir list of a folder.
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/dir/?p=/foo
Sample response
If oid is the same as the current oid of the directory, returns "uptodate" , else returns
[
{
"id": "0000000000000000000000000000000000000000",
"type": "file",
"name": "test1.c",
"size": 0
},
{
"id": "e4fe14c8cda2206bb9606907cf4fca6b30221cf9",
"type": "dir",
"name": "test_dir"
}
]
Sample request
request recursive dir list of a folder.
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d9b477fd" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api2/repos/99b758e6-91ab-4265-b705-925367374cf0/dir/?t=d&recursive=1'
Sample response
[{'id': u'5e307101cad46398fb5fe52d9177836f73c4bae8',
'mtime': 1471490386,
'name': u'123',
'parent_dir': u'/video',
'permission': u'rw',
'type': 'dir'},
{'id': u'0000000000000000000000000000000000000000',
'mtime': 1471490391,
'name': u'123-2',
'parent_dir': u'/video',
'permission': u'rw',
'type': 'dir'},
{'id': u'0000000000000000000000000000000000000000',
'mtime': 1471490379,
'name': u'456',
'parent_dir': u'/video/123',
'permission': u'rw',
'type': 'dir'},
{'id': u'0000000000000000000000000000000000000000',
'mtime': 1471490386,
'name': u'456-2',
'parent_dir': u'/video/123',
'permission': u'rw',
'type': 'dir'},
{'id': u'd8f5f80fbd89bf5634dcf9e21b569c487541d34e',
'mtime': 1471490391,
'name': u'video',
'parent_dir': '/',
'permission': u'rw',
'type': 'dir'}
]
Errors
- 404 The path is not exist.
- 440 Repo is encrypted, and password is not provided.
- 520 Operation failed..
Get Directory Detail
GET http://192.168.1.113:8000/api/v2.1/repos/{repo_id}/dir/detail/?path={path}
- repo_id
- path, should not be
/.
Sample request
curl -H "Authorization: Token e71c00e93af863ba9bcddb61a46bb4de11d713fc" -H 'Accept: application/json; indent=4' "http://192.168.1.113:8000/api/v2.1/repos/d4f596ed-09ea-4ac6-8d59-12acbd089097/dir/detail/?path=Develop"
Sample response
{
"repo_id": "d4f596ed-09ea-4ac6-8d59-12acbd089097",
"name": "Develop",
"file_count": 4,
"dir_count": 1,
"mtime": "2018-01-05T17:45:41+08:00",
"path": "/Develop/",
"size": 397888
}
Errors
- 400 path invalid.
- 403 Permission denied.
- 404 Folder not found.
- 404 Library not found.
- 500 Internal Server Error
Create New Directory
POST https://cloud.seafile.com/api2/repos/{repo-id}/dir/
- repo-id
- p
- operation=mkdir (post)
Sample request
curl -d "operation=mkdir" -v -H 'Authorization: Token 076de58233c09f19e7a5179abff14ad55987350e' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/21b941c2-5411-4372-a514-00b62ab99ef2/dir/?p=/foo
Sample response
...
< HTTP/1.0 201 CREATED
< Location: https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/dir/?p=/foo
...
"success"
Success
Response code 201(Created) is returned, and Location header provides the url of created directory.
Errors
- 400 Path is missing or invalid(e.g. p=/)
- 520 Operation failed.
Notes
Newly created directory will be renamed if the name is duplicated.
Rename Directory
POST https://cloud.seafile.com/api2/repos/{repo-id}/dir/?p=/foo
Parameters
- repo-id
- p (path)
- operation=rename
- newname (the new name of the directory)
Sample request
curl -d "operation=rename&newname=pinkfloyd_newfolder" -v -H 'Authorization: Tokacd9c6ccb8133606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/dir/?p=/foo
Success
Response code 200 if everything is ok
Errors
- 403 if You do not have permission to rename a folder
- 400 if newname is not given
- 520 if Failed to rename directory (generic problem)
Notes
If the new name is the same of the old name no operation will be done.
Delete Directory
DELETE https://cloud.seafile.com/api2/repos/{repo-id}/dir/
- repo-id
- p
Sample request
curl -X DELETE -v -H 'Authorization: Token f2210dacd3606d94ff8e61d99b477fd' -H 'Accept: application/json; charset=utf-8; indent=4' https://cloud.seafile.com/api2/repos/dae8cecc-2359-4d33-aa42-01b7846c4b32/dir/?p=/foo
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code is 200(OK), and a string "success" is returned.
Errors
- 400 Path is missing or invalid(e.g. p=/)
- 520 Operation failed.
Note
This can also be used to delete file.
Download Directory
Perform the following two steps to download directory
Get Task Token
GET https://cloud.seafile.com/api/v2.1/repos/{repo-id}/zip-task/?parent_dir={parent_dir}&dirents={dir}
- repo-id
- parent_dir
- dirents
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/zip-task/?parent_dir=/&dirents=my_dir_name"
Sample response
{
"zip_token": "b2272645-35ee-44ce-8f68-07c022107015"
}
Errors
- 400 parent_dir/dirents invalid.
- 400 Unable to download directory: size is too large.
- 404 Library/Folder not found.
- 403 Permission denied.
- 500 Internal Server Error
Revert Directory
PUT https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/revert/
- repo_id
- p
- commit_id
Sample request
curl -X PUT -d "p=/456&commit_id=b1a33768517f65ac7d618ff078dd27855374c7e0" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api2/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/dir/revert/"
Sample response
{
"success": true
}
Errors
- 400 path invalid.
- 400 commit_id invalid.
- 404 Library/Folder not found.
- 403 Permission denied.
- 500 Internal Server Error
Query Task Progress
Use the token returned from previous request to check if task progress finished.
GET https://cloud.seafile.com/api/v2.1/query-zip-progress/?token={token}
- token
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/query-zip-progress/?token=b2272645-35ee-44ce-8f68-07c022107015"
Sample response
If zipped is equal to total, means task finished.
{
"zipped":2,
"total":2
}
Errors
- 400 token invalid.
- 500 Internal Server Error
After the task finished, you can manually generate directory download url with the zip_token:
FILE_SERVER_ROOT/zip/{zip_token}
For example, https://cloud.seafile.com/seafhttp/zip/b2272645-35ee-44ce-8f68-07c022107015 is the final url here.
Asynchronously Copy/Move File/Directory
Get Task Id
POST https://cloud.seafile.com/api/v2.1/copy-move-task/
Request parameters
- src_repo_id
- src_parent_dir
- src_dirent_name
- dst_repo_id
- dst_parent_dir
- operation,
copyormove - dirent_type,
fileordir
Sample request
Sample for copy file.
curl -d "src_repo_id=534258e2-761b-465c-9e2c-56e021d3853f&src_parent_dir=/&src_dirent_name=file.md&dst_repo_id=a3fa768d-0f00-4343-8b8d-07b4077881db&dst_parent_dir=/&operation=copy&dirent_type=file" -H 'Authorization: Token ae265ae599a29c238ca25fb63087859798d5f55d' -H 'Accept: application/json; charset=utf-8; indent=4' 'http://192.168.1.124:8000/api/v2.1/copy-move-task/'
Sample response
{
"task_id": "d1ca2b8c-8ab8-4dd4-8ad7-842130764484"
}
Errors
- 400 path/operation/dirent_type invalid.
- 404 Library/Folder not found.
- 403 Permission denied.
- 500 Internal Server Error
Cancel Task
DELETE https://cloud.seafile.com/api/v2.1/copy-move-task/
Request parameters
- task_id
Sample request
curl -X DELETE -d "task_id=d1ca2b8c-8ab8-4dd4-8ad7-842130764484" -H 'Authorization: Token ae265ae599a29c238ca25fb63087859798d5f55d' -H 'Accept: application/json; charset=utf-8; indent=4' 'http://192.168.1.124:8000/api/v2.1/copy-move-task/'
Sample response
{
"success": true
}
Errors
- 400 task_id invalid.
- 500 Internal Server Error
Query Progress
GET https://cloud.seafile.com/api/v2.1/query-copy-move-progress/
Request parameters
- task_id
Sample request
curl -H 'Authorization: Token ae265ae599a29c238ca25fb63087859798d5f55d' -H 'Accept: application/json; charset=utf-8; indent=4' 'http://192.168.1.124:8000/api/v2.1/query-copy-move-progress/?task_id=d1ca2b8c-8ab8-4dd4-8ad7-842130764484'
Sample response
{
"successful": true,
"canceled": false,
"total": 1,
"done": 1,
"failed": false
}
Errors
- 400 task_id invalid.
- 500 Internal Server Error
Multiple Files / Directories
Copy
POST https://cloud.seafile.com/api2/repos/{repo_id}/fileops/copy/
Request parameters
- p: source folder path, defaults to
"/" - file_names: list of file/folder names to copy. Multiple file/folder names can be seperated by
:. - dst_repo: the destination repo id
- dst_dir: the destination folder in
dst_repo
Sample request
curl -d "dst_repo=bdf816e6-aba8-468c-962f-77c2fcfd1d1c&dst_dir=/1&file_names=1.md:2.md:test" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; indent=4' "https://cloud.seafile.com/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/fileops/copy/?p=/1/test-2"
Sample response
[
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "1 (2).md"
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "2 (2).md"
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "test (2)"
}
]
Errors
- 400 missing argument
- 403 You do not have permission to copy file
- 404 repo not found
- 502 failed to copy file
Move
POST https://cloud.seafile.com/api2/repos/{repo_id}/fileops/move/
Request parameters
- p: source folder path, defaults to
"/" - file_names: list of file/folder names to move. Multiple file/folder names can be seperated by
:. - dst_repo: the destination repo id
- dst_dir: the destination folder in
dst_repo
Sample request
curl -d "dst_repo=bdf816e6-aba8-468c-962f-77c2fcfd1d1c&dst_dir=/1&file_names=1.md:2.md:test" -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; indent=4' "https://cloud.seafile.com/api2/repos/bdf816e6-aba8-468c-962f-77c2fcfd1d1c/fileops/move/?p=/1/test-2"
Sample response
[
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "1 (3).md"
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "2 (3).md"
},
{
"repo_id": "bdf816e6-aba8-468c-962f-77c2fcfd1d1c",
"parent_dir": "/1",
"obj_name": "test (3)"
}
]
Errors
- 400 missing argument
- 403 You do not have permission to move file
- 404 repo not found
- 502 failed to move file
Delete
POST https://cloud.seafile.com/api2/repos/{repo_id}/fileops/delete/
Request parameters
- p: source folder path, defaults to
"/" - file_names: list of file/folder names to delete. Multiple file/folder names can be seperated by
:.
Sample request
curl -d "file_names=foo.c:bar.c:dir1:dir2" -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' https://cloud.seafile.com/api2/repos/c7436518-5f46-4296-97db-2fcba4c8c8db/fileops/delete/?p=src_path
Sample response
"success"
Errors
- 400 missing argument
- 403 You do not have permission to delete file
- 404 repo not found
- 502 failed to delete file
Download
Perform the following two steps to download multiple files and directories.
Get Task Token
- repo-id
- parent_dir
- dirents
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/repos/7460f7ac-a0ff-4585-8906-bb5a57d2e118/zip-task/?parent_dir=/&dirents=my_dir_name&dirents=my_file_name"
Sample response
{
"zip_token": "b2272645-35ee-44ce-8f68-07c022107015"
}
Errors
- 400 parent_dir/dirents invalid.
- 400 Unable to download directory: size is too large.
- 404 Library/Folder not found.
- 403 Permission denied.
- 500 Internal Server Error
Query Task Progress
Use the token returned from previous request to check if task progress finished.
GET https://cloud.seafile.com/api/v2.1/query-zip-progress/?token={token}
- token
Sample request
curl -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' -H 'Accept: application/json; charset=utf-8; indent=4' "https://cloud.seafile.com/api/v2.1/query-zip-progress/?token=b2272645-35ee-44ce-8f68-07c022107015"
Sample response
If zipped is equal to total, means task finished.
{
"zipped":2,
"total":2
}
Errors
- 400 token invalid.
- 500 Internal Server Error
After the task finished, you can manually generate directory download url with the zip_token:
FILE_SERVER_ROOT/zip/{zip_token}
For example, https://cloud.seafile.com/seafhttp/zip/b2272645-35ee-44ce-8f68-07c022107015 is the final url here.
Avatar
Update User Avatar
POST https://cloud.seafile.com/api/v2.1/user-avatar/
Request parameters
avatar: image file
Sample request
curl -H "Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154" -F "[email protected]" https://cloud.seafile.com/api/v2.1/user-avatar/
Sample response
{"success": true}
Errors
- 400 invalid file extension
- 400 file is too big
- 500 Internal Server Error
Get User Avatar
GET https://cloud.seafile.com/api2/avatars/user/{user}/resized/{size}/
Request parameters
- user
- size
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/avatars/user/[email protected]/resized/80/"
Sample response
{
"url": "http://127.0.0.1:8000/media/avatars/default.png",
"is_default": true,
"mtime": 0
}
Get Group Avatar
GET https://cloud.seafile.com/api2/avatars/group/{group_id}/resized/{size}/
Request parameters
- group_id
- size
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/avatars/group/1/resized/80/"
Sample response
{
"url": "http://127.0.0.1:8000/media/avatars/groups/default.png",
"is_default": true,
"mtime": 0
}
Devices
Get User Devices
GET https://cloud.seafile.com/api2/devices/
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/devices/
Sample response
[
{
"synced_repos": [
{
"repo_id": "47945b31-dedb-4b92-a048-32bf825595ce",
"sync_time": 1458008928,
"repo_name": "wopi"
},
{
"repo_id": "78c620ee-2989-4427-8eff-7748f4fbebc0",
"sync_time": 1457943466,
"repo_name": "lib-of-lian"
}
],
"last_accessed": "2016-03-15T10:28:48+08:00",
"device_name": "lian",
"platform_version": "",
"platform": "linux",
"user": "[email protected]",
"key": "99abe1a7cc7d614db0bfa19db81e42ef675abe4f",
"client_version": "5.0.0",
"last_login_ip": "192.168.1.16",
"device_id": "be10980211752515053bf9036a13139375de0cc8"
},
{
"last_accessed": "2016-03-15T13:59:51+08:00",
"device_name": "PLK-AL10",
"platform_version": "5.0.2",
"platform": "android",
"user": "[email protected]",
"key": "067051c94163ed193f2131d48c61882daa7cb238",
"client_version": "2.0.3",
"last_login_ip": "192.168.1.208",
"device_id": "4a0d62c1f27b3b74"
}
]
Errors
- 401 UNAUTHORIZED
Unlink User Device
DELETE https://cloud.seafile.com/api2/devices/
Request parameters
- platform
- device_id
Sample request
curl -X DELETE -d "platform=linux&device_id=be10980211752515053bf9036a13139375de0cc8" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/devices/
Sample response
{"success": true}
Errors
- 400 platform invalid
- 400 device_id invalid
- 500 Internal Server Error
Snapshot Label
Get Snapshot Label
GET https://cloud.seafile.com/api/v2.1/revision-tags/tag-names/
Sample request
Sample for get snapshot label
curl -H 'Authorization: Token 88aaa1e6fe35d0444868b4c67f8ca1766cf82f55' -H 'Accept: application/json; indent=4' http://cloud.seafile.com/api/v2.1/revision-tags/tag-names/
Sample response
[
"q1",
"qwe",
"qwe",
"qwe_-.12",
"qwe_-1.",
"r",
"r",
"v3",
"\u4e2d\u6587",
"\u82f1\u6587"
]
Create New Snapshot Label
POST https://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/
Request parameters
- repo_id
- commit_id, optional
- tag_names
Sample request
Sample for create snapshot label.
curl -d "repo_id=7377c95d-b303-4914-a555-306651cc4cbf&commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf&tag_names=v2.1,v2.2" -H 'Authorization: Token 88aaa1e6fe35d0444868b4c67f8ca1766cf82f55' -H 'Accept: application/json; indent=4' http://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/
Sample response
{
"revisionTags": [
{
"tag": "v2.1",
"tag_creator": "[email protected]",
"revision": {
"commit_id": "4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"repo_id": "7377c95d-b303-4914-a555-306651cc4cbf",
"contact_email": "[email protected]",
"name": "foo",
"time": "2017-09-13T15:20:54+08:00",
"link": "/repo/history/view/7377c95d-b303-4914-a555-306651cc4cbf/?commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"email": "[email protected]",
"description": "Added \"ca (1).js\"."
}
},
{
"tag": "v2.2",
"tag_creator": "[email protected]",
"revision": {
"commit_id": "4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"repo_id": "7377c95d-b303-4914-a555-306651cc4cbf",
"contact_email": "[email protected]",
"name": "foo",
"time": "2017-09-13T15:20:54+08:00",
"link": "/repo/history/view/7377c95d-b303-4914-a555-306651cc4cbf/?commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"email": "[email protected]",
"description": "Added \"ca (1).js\"."
}
}
]
}
Errors
- 400 repo_id/commit_id/tag_names invalid.
- 403 Permission denied(need rw permission).
Update Snapshot Label
PUT https://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/
Request parameters
- repo_id
- commit_id(default is head commit if commit_id is empty)
- tag_names
Sample request
Sample for update snapshot label.
curl -X PUT -d "repo_id=7377c95d-b303-4914-a555-306651cc4cbf&commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf&tag_names=v3" -H 'Authorization: Token 88aaa1e6fe35d0444868b4c67f8ca1766cf82f55' -H 'Accept: application/json; indent=4' http://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/
Sample response
{
"revisionTags": [
{
"tag": "v3",
"tag_creator": "[email protected]",
"revision": {
"commit_id": "4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"repo_id": "7377c95d-b303-4914-a555-306651cc4cbf",
"contact_email": "[email protected]",
"name": "foo",
"time": "2017-09-13T15:20:54+08:00",
"link": "/repo/history/view/7377c95d-b303-4914-a555-306651cc4cbf/?commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"email": "[email protected]",
"description": "Added \"ca (1).js\"."
}
}
]
}
Errors
- 400 repo_id/commit_id/tag_names invalid.
- 403 Permission denied(need rw permission).
Delete Snapshot Label
Delete https://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/
Request parameters
- repo_id
- tag_name
Sample request
Sample for update snapshot label.
curl -X DELETE -H 'Authorization: Token 88aaa1e6fe35d0444868b4c67f8ca1766cf82f55' -H 'Accept: application/json; indent=4' -sS 'http://cloud.seafile.com/api/v2.1/revision-tags/tagged-items/?repo_id=7377c95d-b303-4914-a555-306651cc4cbf&tag_names=v3'
Sample response
{}
Errors
- 400 repo_id/tag_names invalid.
- 403 Permission denied(need rw permission).
Get File Activities
GET https://cloud.seafile.com/api2/events/
Request parameters
this api will only return first 15 records of activities. if want get more, pass start parameter
- start (default 0)
- size (size of user avatar, default 36)
Sample request
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/events/"
Sample response
{'events': [{'author': u'[email protected]',
'avatar': '<img src="/media/avatars/default.png" width="36" height="36" class="avatar" />',
'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'date': '2016-05-06',
'etype': u'repo-delete',
'name': u'lian',
'nick': u'lian',
'repo_id': u'13e2ae06-8927-465b-8f57-319b3a7cfbdd',
'repo_name': u'2',
'time': 1462552942,
'time_relative': u'<time datetime="2016-05-06T16:42:22.967104" is="relative-time" title="Fri, 6 May 2016 16:42:22 +0800" >19 hours ago</time>'},
{'author': u'[email protected]',
'avatar': '<img src="/media/avatars/default.png" width="36" height="36" class="avatar" />',
'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'commit_id': u'1be92d40a1b526863bbf39e8abdae7d317a1195f',
'converted_cmmt_desc': u'Modified "<a href="/convert_cmmt_desc_link/?repo_id=47945b31-dedb-4b92-a048-32bf825595ce&cmmt_id=1be92d40a1b526863bbf39e8abdae7d317a1195f&nm=excel-view.xlsx" class="normal">excel-view.xlsx</a>"',
'date': '2016-04-25',
'desc': u'Modified "excel-view.xlsx"',
'etype': u'repo-update',
'more_files': False,
'name': u'lian',
'nick': u'lian',
'repo_encrypted': False,
'repo_id': u'47945b31-dedb-4b92-a048-32bf825595ce',
'repo_name': u'wopi',
'time': 1461569125,
'time_relative': u'<time datetime="2016-04-25T15:25:25" is="relative-time" title="Mon, 25 Apr 2016 15:25:25 +0800" >11 days ago</time>'}
...
],
'more': True,
'more_offset': 15}
Sample request for more activities
curl -H 'Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd' "https://cloud.seafile.com/api2/events/?start=15"
Sample response for more activities
{'events': [{'author': u'[email protected]',
'avatar': '<img src="/media/avatars/default.png" width="36" height="36" class="avatar" />',
'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'date': '2016-05-06',
'etype': u'repo-delete',
'name': u'lian',
'nick': u'lian',
'repo_id': u'13e2ae06-8927-465b-8f57-319b3a7cfbdd',
'repo_name': u'2',
'time': 1462552942,
'time_relative': u'<time datetime="2016-05-06T16:42:22.967104" is="relative-time" title="Fri, 6 May 2016 16:42:22 +0800" >19 hours ago</time>'},
{'author': u'[email protected]',
'avatar': '<img src="/media/avatars/default.png" width="36" height="36" class="avatar" />',
'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'commit_id': u'1be92d40a1b526863bbf39e8abdae7d317a1195f',
'converted_cmmt_desc': u'Modified "<a href="/convert_cmmt_desc_link/?repo_id=47945b31-dedb-4b92-a048-32bf825595ce&cmmt_id=1be92d40a1b526863bbf39e8abdae7d317a1195f&nm=excel-view.xlsx" class="normal">excel-view.xlsx</a>"',
'date': '2016-04-25',
'desc': u'Modified "excel-view.xlsx"',
'etype': u'repo-update',
'more_files': False,
'name': u'lian',
'nick': u'lian',
'repo_encrypted': False,
'repo_id': u'47945b31-dedb-4b92-a048-32bf825595ce',
'repo_name': u'wopi',
'time': 1461569125,
'time_relative': u'<time datetime="2016-04-25T15:25:25" is="relative-time" title="Mon, 25 Apr 2016 15:25:25 +0800" >11 days ago</time>'}
...
],
'more': True,
'more_offset': 30}
Get Thumbnail Image
GET https://cloud.seafile.com/api2/repos/{repo_id}/thumbnail/
Request parameters
- repo_id
- p
- size
Sample request
curl -H 'Authorization: Token 40f9a510a0629430865dc199a3880898ad2e48fc' https://cloud.seafile.com/api2/repos/fbead5d0-4817-4446-92f3-7ac8e6a8e5f5/thumbnail/?p=/5.jpg\&size=123 > thumbnail.png
Search User
GET https://cloud.seafile.com/api2/search-user/?q=foo
Request parameters
- q
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/search-user/?q=foo
Sample response
[
{'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'contact_email': u'[email protected]',
'email': u'[email protected]',
'name': 'foo'},
{'avatar_url': 'https://cloud.seafile.com/media/avatars/default.png',
'contact_email': u'[email protected]',
'email': u'[email protected]',
'name': 'foo-bar'}
]
Errors
- 400 Argument missing.
- 403 Guest user can not use global address book.
Note: The following APIs are only available since Seafile v5.1.
Admin Only
Account
List Accounts
GET https://cloud.seafile.com/api2/accounts/
Request parameters
- start (default to 0)
- limit (default to 100)
- scope (default None, accepted values: 'LDAP' or 'DB' or 'LDAPImport')
To retrieve all users, just set both start and limit to -1.
If scope parameter is passed then accounts will be searched inside the specific scope, otherwise it will be used the old approach: first LDAP and, if no account is found, DB.
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/
Sample response
[
{
"email": "[email protected]"
},
{
"email": "[email protected]"
}
]
Errors
- 403 Permission error, only administrator can perform this action
Get Account Info
GET https://cloud.seafile.com/api2/accounts/{email}/
Request parameters
Sample request
curl -v -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/[email protected]/
Sample response
{
"is_staff": false,
"is_active": true,
"id": 2,
"create_time": 1356061187741686,
"usage": 651463187,
"total": 107374182400,
"email": "[email protected]"
}
Errors
- 403 Permission error, only administrator can perform this action
Create Account
PUT https://cloud.seafile.com/api2/accounts/{email}/
Request parameters
- password
- is_staff (defaults to False)
- is_active (defaults to True)
Sample request
curl -v -X PUT -d "password=123456" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/[email protected]/
Sample response
...
< HTTP/1.0 201 CREATED
< Location: https://cloud.seafile.com/api2/accounts/[email protected]/
...
"success"
Success
Response code 201(Created) is returned and the Location header provides shared link.
Errors
- 403 Permission error, only administrator can perform this action
Update Account
PUT https://cloud.seafile.com/api2/accounts/{email}/
Request parameters
At least one of followings:
- password
- is_staff
- is_active
- name
- note
- storage, the unit is MB.
Sample request
curl -v -X PUT -d "password=654321&is_staff=true&storage=100" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/[email protected]/
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code 200(OK) is returned.
Errors
- 400 Bad Request, keyword password is required
- 403 Permission error, only administrator can perform this action
Migrate Account
POST https://cloud.seafile.com/api2/accounts/{email}/
Request parameters
- op
- to_user this user must exist
Sample request
curl -v -d "op=migrate&[email protected]" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/[email protected]/
Sample response
...
< HTTP/1.0 200 OK
...
"success"
Success
Response code 200(OK) is returned.
Errors
- 400 Bad Request, arguments are missing or invalid
- 403 Permission error, only administrator can perform this action
Delete Account
DELETE https://cloud.seafile.com/api2/accounts/{email}/
Sample request
curl -v -X DELETE -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/accounts/[email protected]/
Sample response
"success"
Errors
- 403 Permission error, only administrator can perform this action
Devices
Get Desktop Devices
Get first page (50 records per page) of desktop devices.
GET https://cloud.seafile.com/api/v2.1/admin/devices/?platform=desktop&page=1&per_page=50
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/devices/?platform=desktop&page=1&per_page=50
Sample response
[
{'has_next_page': False},
[
{
'last_accessed': '2016-04-11T18:24:29+08:00',
'last_login_ip': u'192.168.1.210',
'platform': u'linux',
'user': u'[email protected]',
'client_version': u'2.0.4',
'device_name': u'PLK-AL10',
'device_id': u'4a0d62c1f27b3b74'
}
]
]
Errors
- 403 Permission error, only administrator can perform this action
Get Mobile Devices
Get first page (50 records per page) of mobile devices.
GET https://cloud.seafile.com/api/v2.1/admin/devices/?platform=mobile&page=1&per_page=50
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/devices/?platform=mobile&page=1&per_page=50
Sample response
[
{'has_next_page': False},
[
{
'last_accessed': '2016-04-11T18:24:29+08:00',
'last_login_ip': u'192.168.1.210',
'platform': u'ios',
'user': u'[email protected]',
'client_version': u'2.0.4',
'device_name': u'PLK-AL10',
'device_id': u'4a0d62c1f27b3b74'
}
]
]
Errors
- 403 Permission error, only administrator can perform this action
Unlink User Device
DELETE https://cloud.seafile.com/api/v2.1/admin/devices/
Request parameters
- platform
- device_id
- user
Sample request
curl -X DELETE -d "platform=linux&device_id=be10980211752515053bf9036a13139375de0cc8&[email protected]" -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/devices/
Sample response
{"success": true}
Errors
- 400 platform invalid
- 400 device_id invalid
- 400 user invalid
- 500 Internal Server Error
Get Device Errors
This api is only supported in pro edition.
GET https://cloud.seafile.com/api/v2.1/admin/device-errors/
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/device-errors/
Sample response
[
{
'repo_id': u'47945b31-dedb-4b92-a048-32bf825595ce',
'device_ip': u'192.168.1.124',
'error_time': '2016-04-13T17:49:11+08:00',
'device_name': u'lian-ubuntu-1404-64',
'email': u'[email protected]',
'client_version': u'5.0.6',
'error_msg': u'No permission.',
'repo_name': u'wopi'
}
]
Errors
- 403 Feature disabled.
- 500 Internal Server Error
Clean Device Errors
This api is only supported in pro edition.
DELETE https://cloud.seafile.com/api/v2.1/admin/device-errors/
Sample request
curl -X DELETE -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/device-errors/
Sample response
{"success":true}
Errors
- 403 Feature disabled.
- 500 Internal Server Error
Get Snapshots by Label
GET https://cloud.seafile.com/api/v2.1/admin/revision-tags/tagged-items/
Request parameters
- user, optional
- repo_id, optional
- tag_name, optional
- tag_contains, optional
Sample request
Sample for get snapshots by label
curl -H 'Authorization: Token 88aaa1e6fe35d0444868b4c67f8ca1766cf82f55' -H 'Accept: application/json; indent=4' http://cloud.seafile.com/api/v2.1/admin/revision-tags/tagged-items/?repo_id=7377c95d-b303-4914-a555-306651cc4cbf&tag_contains=v
Sample response
[
{
"tag": "v3",
"tag_creator": "[email protected]",
"revision": {
"commit_id": "4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"repo_id": "7377c95d-b303-4914-a555-306651cc4cbf",
"contact_email": "[email protected]",
"name": "foo",
"time": "2017-09-13T15:20:54+08:00",
"link": "/repo/history/view/7377c95d-b303-4914-a555-306651cc4cbf/?commit_id=4c03938da11e83d6c1d3e8ff469e92f46a80eeaf",
"email": "[email protected]",
"description": "Added \"ca (1).js\"."
}
}
]
Default Library
Get User Default Library
Available for Seafile v6.0.9+
GET https://cloud.seafile.com/api/v2.1/admin/default-library/{user_email}
Sample request
curl -H 'Authorization: Token 024692f8411a656baa2cc2d5ed4cd46177b3b3d0' "https://cloud.seafile.com/api/v2.1/admin/default-library/[email protected]"
Sample response
{
"repo_id":"9e58655f-d2a2-4df9-baa2-5ca50698ad98",
"exists":true,
"user_email":"[email protected]"
}
Errors
- 400 user_email invalid.
- 404 User not found.
- 403 Permission error, only administrator can perform this action.
- 500 Internal Server Error
Create User Default Library
Available for Seafile v6.0.9+
POST https://cloud.seafile.com/api/v2.1/admin/default-library/
Sample request
curl -d "[email protected]" -H 'Authorization: Token 024692f8411a656baa2cc2d5ed4cd46177b3b3d0' "https://cloud.seafile.com/api/v2.1/admin/default-library/"
Sample response
{
"repo_id":"9e58655f-d2a2-4df9-baa2-5ca50698ad98",
"exists":true,
"user_email":"[email protected]"
}
Errors
- 400 user_email invalid.
- 403 Permission error, only administrator can perform this action.
- 403 Permission error, user can not create library.
- 404 User not found.
- 500 Internal Server Error
Libraries
Get all Libraries
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/libraries/?page=1&per_page=100
Get first page (100 records per page) of libraries.
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/libraries/?page=1&per_page=100
Sample response
{
"page_info": {
"current_page": 1,
"has_next_page": true
},
"repos": [
{
"name": null,
"encrypted": false,
"file_count": 0,
"owner": "[email protected]",
"size_formatted": "0 bytes",
"id": "04df5005-1dfc-4e30-ae55-95ed6559583f",
"size": 0
},
{
"name": "My Library",
"encrypted": false,
"file_count": 161,
"owner": "[email protected]",
"size_formatted": "25.4 MB",
"id": "2deffbac-d7be-4ace-b406-efb799083ee9",
"size": 26617460
}
...
]
}
Errors
- 403 Permission error, only administrator can perform this action
Search Library by Name
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/libraries/?name=file
Request parameters
- name
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/libraries/?name=file
Sample response
{
"owner": "",
"repos": [
{
"name": "file-preview",
"encrypted": false,
"file_count": 25,
"owner": "[email protected]",
"size_formatted": "10.9 MB",
"id": "6ce1383b-ed1c-45c7-ab31-a13b64471e64",
"size": 11437897
}
],
"name": "file"
}
Errors
- 403 Permission error, only administrator can perform this action
Search Library by Owner
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/libraries/[email protected]
Request parameters
- owner
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/libraries/[email protected]
Sample response
{
"owner": "[email protected]",
"repos": [
{
"name": "lib-of-lian",
"encrypted": false,
"file_count": 0,
"owner": "[email protected]",
"size_formatted": "16.5 KB",
"id": "78c620ee-2989-4427-8eff-7748f4fbebc0",
"size": 16883
},
{
"name": "encrypted",
"encrypted": true,
"file_count": 0,
"owner": "[email protected]",
"size_formatted": "18.1 MB",
"id": "47695bb8-3364-4274-939d-3c5a0df9710c",
"size": 18997225
},
...
],
"name": ""
}
Errors
- 403 Permission error, only administrator can perform this action
Delete a Library
Available for Seafile v6.0.0+
DELETE https://cloud.seafile.com/api/v2.1/admin/libraries/{repo_id}/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/libraries/ee3b2d19-1a06-47f0-bbfa-554cab3bdedc/
Sample response
{"success":true}
Errors
- 403 Permission error, only administrator can perform this action
Transfer a Library
Available for Seafile v6.0.0+
PUT https://cloud.seafile.com/api/v2.1/admin/libraries/{repo_id}/
Sample request
curl -X PUT -d "[email protected]" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/libraries/ee3b2d19-1a06-47f0-bbfa-554cab3bdedc/
Sample response
{
"name": "test-repo",
"encrypted":false,
"file_count":0,
"owner":"[email protected]",
"size_formatted":"0 bytes",
"id":"ee3b2d19-1a06-47f0-bbfa-554cab3bdedc",
"size":0
}
Errors
- 400 owner invalid.
- 403 Permission error, only administrator can perform this action
- 404 User not found.
- 404 Library not found.
- 500 Internal Server Error
Get Library Dirents
GET https://cloud.seafile.com/api/v2.1/admin/libraries/{repo_id}/dirents/?parent_dir={parent_dir}
- repo-id
- parent_dir
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/libraries/104f6537-b3a5-4d42-b8b5-8e47e494e4cf/dirents/?parent_dir=/asd
Sample response
{
"repo_id": "c474a093-19dc-4ddf-b0b0-72b33214ba33",
"dirent_list": [
{
"file_size": "",
"last_update": "2016-12-19T03:35:14+00:00",
"is_file": false,
"obj_name": "book"
},
{
"file_size": "",
"last_update": "2016-10-12T07:43:32+00:00",
"is_file": false,
"obj_name": "image"
},
{
"file_size": "47.0 KB",
"last_update": "2017-02-13T02:41:05+00:00",
"is_file": true,
"obj_name": "123.md"
}
],
"is_system_library": false,
"repo_name": "seacloud.cc.124"
}
Errors
- 400 parent_dir invalid.
- 403 Feature disabled.
- 403 Permission error, only administrator can perform this action
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Shares
Get Repo User Shares
Available for Seafile v6.0.1+
GET https://cloud.seafile.com/api/v2.1/admin/shares/?repo_id={repo_id)&share_type={share_type}
Request parameters
- repo_id
- share_type
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/?repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=user'
Sample response
[
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "user",
"permission": "r",
"path": "/",
"user_name": "name of user 2",
"user_email": "[email protected]"
}
]
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Get Repo Group Shares
Available for Seafile v6.0.1+
GET https://cloud.seafile.com/api/v2.1/admin/shares/?repo_id={repo_id)&share_type={share_type}
Request parameters
- repo_id
- share_type
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/?repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=group'
Sample response
[
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "group",
"permission": "rw",
"group_name": "group-of-lian-2",
"path": "/",
"group_id": 2
}
]
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Share Repo to User
Available for Seafile v6.0.1+
POST https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (user email)
- permission
Sample request
curl -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=user&permission=r&[email protected]&[email protected]" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"failed": [
{
"error_msg": "User [email protected] not found.",
"user_email": "[email protected]"
}
],
"success": [
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "user",
"permission": "r",
"path": "/",
"user_name": "name of user 1",
"user_email": "[email protected]"
}
]
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Share Repo to Group
Available for Seafile v6.0.1+
POST https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (group_id)
- permission
Sample request
curl -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=group&permission=r&share_to=1&share_to=1232" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"failed": [
{
"group_id": 1232,
"error_msg": "Group %s not found"
}
],
"success": [
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "group",
"permission": "r",
"group_name": "group-of-lian",
"path": "/",
"group_id": 1
}
]
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Modify Repo User Share Permission
Available for Seafile v6.0.1+
PUT https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (user email)
- permission
Sample request
curl -X PUT -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=user&permission=rw&[email protected]" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "user",
"permission": "rw",
"path": "/",
"user_name": "name of user 1",
"user_email": "[email protected]"
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Modify Repo Group Share Permission
Available for Seafile v6.0.1+
PUT https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (group_id)
- permission
Sample request
curl -X PUT -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=group&permission=rw&share_to=1" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"repo_id": "ddd42241-e003-425d-960e-0f9f7144866f",
"share_type": "group",
"permission": "rw",
"group_name": "group-of-lian",
"path": "/",
"group_id": 1
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Delete Repo User Share
Available for Seafile v6.0.1+
DELETE https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (user email)
Sample request
curl -X DELETE -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=user&[email protected]" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"success": true
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Delete Repo Group Share
Available for Seafile v6.0.1+
DELETE https://cloud.seafile.com/api/v2.1/admin/shares/
Request parameters
- repo_id
- share_type
- share_to (group id)
Sample request
curl -X DELETE -d "repo_id=ddd42241-e003-425d-960e-0f9f7144866f&share_type=group&share_to=1" -H "Authorization: Token 9c845638b855e549c07ff81be2a0471aa52810d7" -H 'Accept: application/json; indent=4' 'https://cloud.seafile.com/api/v2.1/admin/shares/'
Sample response
{
"success": true
}
Errors
- 400 repo_id invalid.
- 400 share_type invalid.
- 403 Permission denied.
- 404 Library not found.
- 404 Folder not found.
- 500 Internal Server Error
Groups
Get all groups
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/groups/?page=1&per_page=100
Get first page (100 records per page) of groups.
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/groups/?page=1&per_page=100
Sample response
{
"page_info": {
"current_page": 1,
"has_next_page": true
},
"groups": [
{
"owner": "[email protected]",
"created_at": "2016-08-01T16:58:14+08:00",
"id": 1476,
"name": "test_group"
},
{
"owner": "[email protected]",
"created_at": "2016-08-02T16:48:14+08:00",
"id": 1486,
"name": "group"
}
...
]
}
Errors
- 403 Permission error, only administrator can perform this action
Delete a Group
Available for Seafile v6.0.0+
DELETE https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/groups/1486/
Sample response
{"success":true}
Errors
- 403 Permission error, only administrator can perform this action
Transfer a Group
Available for Seafile v6.0.0+
PUT https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/
Sample request
curl -X PUT -d "[email protected]" -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/groups/1528/
Sample response
{
"owner": "[email protected]",
"created_at": "2016-08-04T17:34:05+08:00",
"id": 1528,
"name": "test_group"
}
Errors
- 403 Permission error, only administrator can perform this action
- 404 User not found.
- 500 Internal Server Error
Get Group Libraries
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/libraries/
Get all libraries of a group.
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/groups/64/libraries/
Sample response
[
{
"repo_id":"7460f7ac-a0ff-4585-8906-bb5a57d2e118",
"name":"My Library",
"permission":"rw",
"group_id":65,
"shared_by":"[email protected]",
"size":97662
}
]
Errors
- 403 Permission error, only administrator can perform this action
- 404 Group not found.
Delete Group Library
Available for Seafile v6.0.0+
DELETE https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/libraries/{repo_id}/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/groups/64/libraries/7460f7ac-a0ff-4585-8906-bb5a57d2e118/
Sample response
{"success":true}
Errors
- 403 Permission error, only administrator can perform this action
- 404 Library/Group not found.
- 500 Internal Server Error
Get Group Members
Available for Seafile v6.0.0+
GET https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/members/
Get all members of a group.
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/groups/64/members/
Sample response
[
{
"login_id":"",
"avatar_url":"https://cloud.seafile.com/media/avatars/0/1/a72299021077701e7c522c46fdaa87/resized/80/6ad30837f69ea7ef234dc272fb15e9e9.png",
"contact_email":"[email protected]",
"name":"name of lian",
"is_admin":true,
"role":"Owner",
"group_id":65,
"email":"[email protected]"
},
{
"login_id":"",
"avatar_url":"https://cloud.seafile.com/media/avatars/default.png",
"contact_email":"[email protected]",
"name":"123",
"is_admin":false,
"role":"Member",
"group_id":65,
"email":"[email protected]"
}
]
Errors
- 403 Permission error, only administrator can perform this action
- 404 Group not found.
Delete Group Member
Available for Seafile v6.0.0+
DELETE https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/members/{email}/
Sample request
curl -X DELETE -H 'Authorization: Token 444d2bbf1fc78ffbeedc4704c9f41e32d926ac94' https://cloud.seafile.com/api/v2.1/admin/groups/64/members/[email protected]/
Sample response
{"success":true}
Errors
- 403 Permission error, only administrator can perform this action
- 403 [email protected] is group owner, can not be removed.
- 404 Group not found.
- 500 Internal Server Error
Add Group Member
Available for Seafile v6.0.8+
POST https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/members/
Sample request
curl -d "[email protected]&[email protected]" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' https://cloud.seafile.com/api/v2.1/admin/groups/65/members/
Sample response
{
"failed":[
{
"email":"[email protected]","error_msg":"User [email protected] is already a group member."
}
],
"success":[
{
"login_id":"",
"avatar_url":"https://cloud.seafile.com/media/avatars/default.png",
"contact_email":"[email protected]",
"name":"name of 8",
"is_admin":0,
"role":"Member",
"group_id":65,
"email":"[email protected]"
}
]
}
Errors
- 400 email invalid.
- 404 Group not found.
Update Group Member Role
Available for Seafile v6.0.8+
Set a group member as admin
PUT https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/members/{email}
Sample request
curl -X PUT -d "is_admin=true" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' https://cloud.seafile.com/api/v2.1/admin/groups/65/members/[email protected]/
Sample response
{
"login_id":"",
"avatar_url":"https://cloud.seafile.com/media/avatars/default.png",
"contact_email":"[email protected]",
"name":"update name of 3",
"is_admin":1,
"role":"Admin",
"group_id":65,
"email":"[email protected]"
}
Errors
- 400 email invalid.
- 400 is_admin invalid.
- 404 Group/User not found.
- 500 Internal Server Error
Unset a group member as admin
PUT https://cloud.seafile.com/api/v2.1/admin/groups/{group_id}/members/{email}
Sample request
curl -X PUT -d "is_admin=false" -H 'Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a' https://cloud.seafile.com/api/v2.1/admin/groups/65/members/[email protected]/
Sample response
{
"login_id":"",
"avatar_url":"https://cloud.seafile.com/media/avatars/default.png",
"contact_email":"[email protected]",
"name":"update name of 3",
"is_admin":0,
"role":"Member",
"group_id":65,
"email":"[email protected]"
}
Errors
- 400 email invalid.
- 400 is_admin invalid.
- 404 Group/User not found.
- 500 Internal Server Error
Shared Links
Download Links
Get Shared File/Dir Info
GET http://192.168.1.124:8000/api/v2.1/admin/share-links/{token}/
Request parameters
- token
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/db62f56baf1b4460996e/"
Sample response
{
"repo_id": "0a5647c8-7708-445a-bd80-49f04b85b153",
"ctime": "2017-06-20T08:37:13+00:00",
"creator_name": "name of lian",
"creator_email": "[email protected]",
"obj_name": "asdf",
"token": "db62f56baf1b4460996e",
"view_cnt": 8,
"link": "http://192.168.1.124:8000/d/db62f56baf1b4460996e/",
"expire_date": "2017-06-23T08:37:13+00:00",
"path": "/asdf/",
"creator_contact_email": "[email protected]",
"is_dir": true,
"permissions": {
"can_preview": true,
"can_download": true
},
"is_expired": false,
"repo_name": "sadfdaa"
}
Errors
- 403 Permission denied.
- 404 Share link not found.
Get Sub File/Dir List in Shared Dir
GET http://192.168.1.124:8000/api/v2.1/admin/share-links/{token}/dirents/
Request parameters
- token
- path, sub-folder of shared dir, default is
/.
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/db62f56baf1b4460996e/dirents/?path=/sdf"
Sample response
[
{
"path": "/sdf/1122",
"is_dir": true,
"size": 0,
"last_modified": "2017-06-21T02:18:40+00:00",
"obj_name": "1122"
},
{
"path": "/sdf/12.docx",
"is_dir": false,
"size": 457426,
"last_modified": "2017-06-20T10:09:53+00:00",
"obj_name": "12.docx"
},
{
"path": "/sdf/slack-desktop-2.3.3-amd64.deb",
"is_dir": false,
"size": 47434600,
"last_modified": "2017-06-20T10:27:47+00:00",
"obj_name": "slack-desktop-2.3.3-amd64.deb"
}
]
Errors
- 403 Permission denied.
- 404 Share link not found.
Download File/Dir
GET http://192.168.1.124:8000/api/v2.1/admin/share-links/{token}/download/
Request parameters
- token
- type, only used for download (sub) file/folder of shared dir,
fileorfolder. - path, only used for download (sub) file/folder of shared dir.
Sample request for download (sub) folder in shared dir
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/db62f56baf1b4460996e/download/?path=/sdf&type=folder"
Sample response for download (sub) folder in shared dir
{
"download_link": "http://192.168.1.124:8082/zip/395e0ea8-3936-4084-b650-64a93d8a313d"
}
After you get the download link for the (sub) folder, you should use the token in the download link (here's 395e0ea8-3936-4084-b650-64a93d8a313d) to check if the background compression packaging has been completed by Query Task Progress, once it is finished, you can use the download link to download the (sub) folder.
Sample request for download (sub) file in shared dir
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/db62f56baf1b4460996e/download/?path=/sdf/12.docx&type=file"
Sample response for download (sub) file in shared dir
{
"download_link": "http://192.168.1.124:8082/files/2fec8ae7-ffd5-4586-b125-7234e7a69656/12.docx"
}
Sample request for download shared file
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/dac219add64f4a4b9c51/download/"
Sample response for download shared file
{
"download_link": "http://192.168.1.124:8082/files/a34af6cb-4762-4eea-b5a4-0b924e6767d0/excel-view.xlsx"
}
Errors
- 403 Permission denied.
- 404 Share link not found.
- 404 File not found.
- 404 Folder not found.
- 404 Library not found.
- 500 Internal Server Error
Check Password
GET http://192.168.1.124:8000/api/v2.1/admin/share-links/{token}/check-password/
Request parameters
- token
- password
Sample request
curl -d 'password=11111111' -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/share-links/db62f56baf1b4460996e/check-password/"
Sample response
{
"success": true
}
Errors
- 400 Share link is not encrypted.
- 400 password invalid.
- 403 Permission denied.
- 403 Password is not correct.
- 404 Share link not found.
Upload Links
Get Shared Dir Info
GET http://192.168.1.124:8000/api/v2.1/admin/upload-links/{token}/
Request parameters
- token
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/upload-links/360fe7d6dc684045b7f6/"
Sample response
{
"view_cnt": 0,
"ctime": "2017-06-20T08:37:22+00:00",
"creator_name": "name of lian",
"creator_email": "[email protected]",
"creator_contact_email": "[email protected]",
"token": "360fe7d6dc684045b7f6",
"repo_id": "0a5647c8-7708-445a-bd80-49f04b85b153",
"link": "http://192.168.1.124:8000/u/d/360fe7d6dc684045b7f6/",
"obj_name": "asdf",
"path": "/asdf/",
"repo_name": "sadfdaa"
}
Errors
- 403 Permission denied.
- 404 Upload link not found.
Upload
GET http://192.168.1.124:8000/api/v2.1/admin/upload-links/{token}/upload/
Request parameters
- token
Sample request
curl -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/upload-links/360fe7d6dc684045b7f6/upload/"
Sample response
{
"upload_link": "http://192.168.1.124:8082/upload-api/b08b20e4-beb2-4c7a-af03-fed6be859330"
}
After get upload link, you can upload file to the shared dir, for more info, please see Upload File.
Errors
- 403 Permission denied.
- 404 Upload link not found.
- 404 Folder not found.
Check Password
GET http://192.168.1.124:8000/api/v2.1/admin/upload-links/{token}/check-password/
Request parameters
- token
- password
Sample request
curl -d 'password=11111111' -H 'Authorization: Token cbd7705c06846425ed5c46ae0313d5b098d24154' -H 'Accept: application/json; charset=utf-8; indent=4' "http://192.168.1.124:8000/api/v2.1/admin/upload-links/360fe7d6dc684045b7f6/check-password/"
Sample response
{
"success": true
}
Errors
- 400 Upload link is not encrypted.
- 400 password invalid.
- 403 Permission denied.
- 403 Password is not correct.
- 404 Upload link not found.
Admin Log
Get Login Log
This api is only supported in pro edition.
GET https://cloud.seafile.com/api/v2.1/admin/logs/login/?start=2016-03-20&end=2016-03-31
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/logs/login/?start=2016-03-20&end=2016-03-31
Sample response
[
{
'email': u'[email protected]',
'login_ip': u'192.168.1.124',
'name': u'lian',
'login_time': '2016-03-31T14:42:23+08:00'
},
{
'email': u'[email protected]',
'login_ip': u'192.168.1.124',
'name': u'org',
'login_time': '2016-03-31T14:39:08+08:00'
}
]
Errors
- 400 start or end date invalid.
- 403 Feature disabled.
Get File Audit Log
This api is only supported in pro edition.
GET https://cloud.seafile.com/api/v2.1/admin/logs/file-audit/?start=2016-03-20&end=2016-03-31
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/logs/file-audit/?start=2016-03-20&end=2016-03-31
Sample response
[
{
'repo_id': u'4929d0df-8c6c-43cb-8edf-40a8489689fb',
'time': '2016-03-31T05:46:03+08:00',
'etype': u'file-download-web',
'ip': u'192.168.1.124',
'user_name': u'org',
'file_path': u'/earth.jpg',
'user_email': u'[email protected]',
'repo_name': ''
},
{
'repo_id': u'513cd72c-c54a-463e-a18f-841efe91bd61',
'time': '2016-03-31T06:25:22+08:00',
'etype': u'file-download-web',
'ip': u'192.168.1.124',
'user_name': u'org',
'file_path': u'/kj.md',
'user_email': u'[email protected]',
'repo_name': u'new-lib-of-org-1'
}
]
Errors
- 400 start or end date invalid.
- 403 Feature disabled.
Get File Update Log
This api is only supported in pro edition.
GET https://cloud.seafile.com/api/v2.1/admin/logs/file-update/?start=2016-03-20&end=2016-03-31
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/logs/file-update/?start=2016-03-20&end=2016-03-31
Sample response
[
{
'commit_id': u'55ec5350b16d6c72a044b5a9cd9b2d62ad439364',
'file_operation': u'Added "user.csv".',
'repo_id': u'513cd72c-c54a-463e-a18f-841efe91bd61',
'repo_name': u'new-lib-of-org-1',
'time': '2016-03-31T06:25:15+08:00',
'user_email': u'[email protected]',
'user_name': u'org'
},
{
'commit_id': u'6820d809481e3c9fb856d0650ac73a09b570a301',
'file_operation': u'Added "kj.md"',
'repo_id': u'513cd72c-c54a-463e-a18f-841efe91bd61',
'repo_name': u'new-lib-of-org-1',
'time': '2016-03-31T06:25:21+08:00',
'user_email': u'[email protected]',
'user_name': u'org'
}
]
Errors
- 400 start or end date invalid.
- 403 Feature disabled.
Get Permission Audit Log
This api is only supported in pro edition.
GET https://cloud.seafile.com/api/v2.1/admin/logs/perm-audit/?start=2016-03-20&end=2016-03-31
Sample request
curl -H "Authorization: Token f2210dacd9c6ccb8133606d94ff8e61d99b477fd" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/logs/perm-audit/?start=2016-03-20&end=2016-03-31
Sample response
[
{
'etype': u'add-repo-perm',
'file_path': u'/folder',
'from_email': u'[email protected]',
'from_name': u'org3',
'permission': u'rw',
'repo_id': u'a84544e5-0b84-459d-b1e6-0399dabc76a0',
'repo_name': '',
'time': '2016-03-31T06:21:50+08:00',
'to': u'[email protected]'
},
{
'etype': u'add-repo-perm',
'file_path': u'/folder',
'from_email': u'[email protected]',
'from_name': u'org3',
'permission': u'rw',
'repo_id': u'a84544e5-0b84-459d-b1e6-0399dabc76a0',
'repo_name': '',
'time': '2016-03-31T06:21:53+08:00',
'to': u'777'
}
]
Errors
- 400 start or end date invalid.
- 403 Feature disabled.
Organization
Add Organization
This api is only supported in pro edition.
POST https://cloud.seafile.com/api2/organization/
Request parameters
- username
- password
- org_name
- prefix
- quota
- member_limit
Sample request
curl -v -X POST -d "[email protected]&password=example&org_name=example&prefix=example"a=100&member_limit=10" -H "Authorization: Token ccdff90e4d1efe76b2b3d91c06b027a5cff189d4" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api2/organization/
Sample response
"success"
Add Organization User
This api is only supported in pro edition (since 6.0.9).
POST https://cloud.seafile.com/api/v2.1/admin/organizations/{org_id}/users/
Request parameters
- org_id
- password
Sample request curl -d "[email protected]&password=1&org_name=org-3&prefix=org-3"a=100&member_limit=10" -H "Authorization: Token 3f1e23157c3a1fd740e9dc1c5d748929fe319b95" -H 'Accept: application/json; indent=4' http://192.168.1.165/api2/organization/
Sample response
{
"quota_usage": 0,
"name": "6",
"org_id": 1,
"contact_email": "[email protected]",
"active": true,
"quota_total": -1,
"email": "[email protected]"
}
Errors
- 400 org_id invalid.
- 400 email invalid.
- 400 password invalid.
- 400 User already exists.
- 403 The number of users exceeds the limit.
- 403 Failed. You can only invite %d members.
- 404 Organization not found.
- 500 Fail to add user.
- 500 Internal Server Error
Get Organization User Info
This api is only supported in pro edition (since 6.1.5).
GET https://cloud.seafile.com/api/v2.1/admin/organizations/{org_id}/users/{email}/
Request parameters
- org_id
Sample request
curl -H "Authorization: Token 3f1e23157c3a1fd740e9dc1c5d748929fe319b95" -H 'Accept: application/json; indent=4' http://192.168.1.165/api/v2.1/admin/organizations/1/users/[email protected]/
Sample response
{
"quota_usage": 0,
"name": "6",
"org_id": 1,
"contact_email": "[email protected]",
"active": true,
"quota_total": -1,
"email": "[email protected]"
}
Errors
- 400 org_id invalid.
- 400 User is not member of organization.
- 404 Organization not found.
- 404 User not found.
- 500 Internal Server Error
Updage Organization User Info
This api is only supported in pro edition (since 6.1.5).
PUT https://cloud.seafile.com/api/v2.1/admin/organizations/{org_id}/users/{email}/
Request parameters
- org_id
- active,
trueorfalse - name
- contact_email
- quota_total, integer greater than 0, unit is MB.
Sample request
curl -X PUT -d "active=false&name=name-of-6&[email protected]"a_total=23" -H "Authorization: Token 3f1e23157c3a1fd740e9dc1c5d748929fe319b95" -H 'Accept: application/json; indent=4' http://192.168.1.165/api/v2.1/admin/organizations/1/users/[email protected]/
Sample response
{
"quota_usage": 0,
"name": "name-of-6",
"org_id": 1,
"contact_email": "[email protected]",
"active": false,
"quota_total": 23,
"email": "[email protected]"
}
Errors
- 400 org_id invalid.
- 400 active invalid, should be 'true' or 'false'.
- 400 Failed to set quota.
- 404 Organization not found.
- 404 User not found.
- 500 Internal Server Error
Delete Organization User
This api is only supported in pro edition (since 6.0.9).
DELETE https://cloud.seafile.com/api/v2.1/admin/organizations/{org_id}/users/{email}/
Request parameters
- org_id
Sample request
curl -X DELETE -H "Authorization: Token 0eb24ce5db35a31f70171eca2f760f03f59fa09a" -H 'Accept: application/json; indent=4' https://cloud.seafile.com/api/v2.1/admin/organizations/160/users/[email protected]/
Sample response
{
"success": true
}
Errors
- 400 org_id invalid.
- 403 Failed to delete: is an organization creator.
- 404 Organization not found.
- 404 User not found.
- 500 Internal Server Error