Download OpenAPI specification:Download
Add role for an admin user.
Argument checking:
Permission checking:
default_admin role can perform this action.Created
Update role for an admin user.
Argument checking:
Permission checking:
default_admin role can perform this action.OK
Unshare repo from group
Permission checking:
| repo_id required | string |
| group_id required | string |
No Content
update role of a group member
Permission checking:
| group_id required | string |
| email required | string |
OK
Delete an user from group
Permission checking:
| group_id required | string |
| email required | string |
No Content
Check if password for an encrypted upload link is correct.
Permission checking:
| token required | string |
Created
Copy/move file/dir, and return task id.
Permission checking:
Created
List repo group folder perms (by folder_path).
Permission checking:
| repo_id required | string |
OK
Delete repo group folder perm.
Permission checking:
| repo_id required | string |
No Content
List repo user folder perms (by folder_path).
Permission checking:
| repo_id required | string |
OK
Multi copy folders.
Permission checking:
r/rw permission for src folder.rw permission for dst folder.Parameter: { "src_repo_id":"7460f7ac-a0ff-4585-8906-bb5a57d2e118", "dst_repo_id":"a3fa768d-0f00-4343-8b8d-07b4077881db", "paths":[ {"src_path":"/1/2/3/","dst_path":"/4/5/6/"}, {"src_path":"/a/b/c/","dst_path":"/d/e/f/"}, ] }
Created
Multi copy files/folders. Permission checking:
r/rw permission for src folder.rw permission for dst folder.
Parameter:
{
"src_repo_id":"7460f7ac-a0ff-4585-8906-bb5a57d2e118",
"dst_repo_id":"a3fa768d-0f00-4343-8b8d-07b4077881db",
"paths":[ {"src_path":"/1/2/3/","dst_path":"/4/5/6/"},
{"src_path":"/a/b/c/","dst_path":"/d/e/f/"}, ]
}Created
Multi create folders.
Permission checking:
rw permission for every layer of subdirectories.Parameter: { "repo_id": "4dfdf5b6-806f-4a35-b2b7-604051d2114e", "paths": ["/1/2/", "/3/4/", "/5/6"] }
Created
Multi move files/folders. Permission checking:
rw permission for src folder.rw permission for dst folder.
Parameter:
{
"src_repo_id":"7460f7ac-a0ff-4585-8906-bb5a57d2e118",
"dst_repo_id":"a3fa768d-0f00-4343-8b8d-07b4077881db",
"paths":[ {"src_path":"/1/2/3/","dst_path":"/4/5/6/"},
{"src_path":"/a/b/c/","dst_path":"/d/e/f/"}, ]
}Created
Create, rename, revert dir.
Permission checking:
| repo_id required | string |
Created
Create, rename, move, copy, revert file
Permission checking:
| repo_id required | string |
Created
Get file server token for download-dir and download-multi.
Permission checking:
| repo_id required | string |
OK
Get file upload url according to upload link token.
Permission checking:
| token required | string |
OK
Returns auth token if username and password are valid. For example: curl -d "username=foo@example.com&password=123456" http://127.0.0.1:8000/api2/auth-token/
Created
Returns a simple pong message when client provided an auth token.
For example:
curl -H "Authorization: Token 9944b09199c62bcf9418ad846dd0e4bbdfc6ee4b" http://127.0.0.1:8000/api2/auth/ping/
OK
Generate a token which can be used later to login directly.
This is used to quickly login to restapi from desktop clients. The token can only be used once, and would only be valid in 30 seconds after creation.
Created
Removes the api token of a device that has already logged in. If the device is a desktop client, also remove all sync tokens of repos synced on that client .
Created
Returns a simple pong message when client calls api2/ping/.
For example:
curl http://127.0.0.1:8000/api2/ping/
OK
Delete a comment, only comment author or repo owner can perform this op.
| repo_id required | string |
| id required | string |
No Content
List repo group folder perms (by folder_path).
Permission checking:
| repo_id required | string |
OK
List repo user folder perms (by folder_path).
Permission checking:
| repo_id required | string |
OK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZEDconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: start
description: default 0
required: true
type: string
paramType: query
- name: limit
description: default 100
required: true
type: string
paramType: query
- name: scope
description: LDAP / LDAPIMPORT, DB
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| email required | string |
OK
type: Authorization: required: true type: string email: required: true type: string op: required: true type: string to_user: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
required: true
type: string
paramType: path
- name: op
description: only "migrate"
required: true
type: string
paramType: form
- name: to_user
description: this user must exist
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| email required | string |
Created
Admin - Create/Update Account
Request parameters for create:
password
is_staff: can be "t", "true", "1" (defaults to False)
is_active: can be "t", "true", "1" (defaults to True)
Request parameters for update: At least one of followings:
password
is_staff
is_active
name
note
storage, the unit is MB.
type: Authorization: required: true type: string email: required: true type: string name: required: false type: string password: required: false type: string login_id: required: false type: string is_staff: required: false type: string is_active: required: false type: string is_trial: required: false type: string storage: required: false type: string department: required: false type: string tenant: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
required: true
type: string
paramType: path
- name: password
required: false
type: string
paramType: form
- name: name
required: false
type: string
paramType: form
- name: login_id
required: false
type: string
paramType: form
- name: department
required: false
type: string
paramType: form
- name: tenant
required: false
type: string
paramType: form
- name: storage
required: false
type: string
paramType: form
- name: is_trial
required: false
type: string
paramType: form
- name: is_staff
required: false
type: string
paramType: form
- name: is_active
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERROR
- code: 520
message: OPERATION_FAILEDconsumes:
- application/jsonproduces:
- application/json| email required | string |
OK
type: Authorization: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| email required | string |
No Content
type: activation_key: required: true type: string
parameters:
responseMessages:
consumes:
| activation_key required | string |
OK
Get info of common user's default library.
Permission checking:
type: Authorization: required: true type: string user_email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: user_email
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Create a default library for a common user.
Permission checking:
type: Authorization: required: true type: string user_email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: user_email
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
type: Authorization: required: true type: string page: required: false type: string per_page: required: false type: string platform: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: page
description: default 1
required: false
type: string
paramType: query
- name: per_page
description: default 50
required: false
type: string
paramType: query
- name: platform
description: desktop or mobile
required: true
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string platform: required: true type: string device_id: required: true type: string wipe_device: required: false type: string user: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: platform
description: desktop or mobile
required: true
type: string
paramType: query
- name: device_id
required: true
type: string
paramType: query
- name: wipe_device
description: true or false
required: false
type: string
paramType: query
- name: user
description: User email
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
description: download link token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
No Content
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
List all groups / search group by name
Permission checking:
type: Authorization: required: true type: string name: required: true type: string page: required: false type: string per_page: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: name
required: true
type: string
paramType: query
- name: page
description: default 1
required: false
type: string
paramType: query
- name: per_page
description: default 100
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Create a group
Permission checking:
type: Authorization: required: true type: string group_name: required: true type: string group_owner: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_name
required: true
type: string
paramType: form
- name: group_owner
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
Export groups to excel
Permission checking:
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Admin transfer a group
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string new_owner: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: new_owner
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
Dismiss a specific group
type: Authorization: required: true type: string group_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
No Content
List all group repos
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
Unshare repo from group
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: repo_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
| group_id required | string |
No Content
List all group members
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string avatar_size: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: avatar_size
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
Bulk add group members.
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
description: list of email
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
Created
update role of a group member
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string is_admin: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: path
- name: is_admin
description: true/false
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| email required | string |
OK
Delete an user from group
Permission checking:
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| email required | string |
No Content
List 'all' libraries (by name/owner/page)
Permission checking:
type: Authorization: required: true type: string name: required: false type: string owner: required: false type: string page: required: false type: string per_page: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: name
required: false
type: string
paramType: query
description: name of the library for search
- name: owner
required: false
type: string
paramType: query
description: library owner email
- name: page
required: false
type: string
paramType: query
- name: per_page
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Admin create library
Permission checking:
type: Authorization: required: true type: string name: required: true type: string owner: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: name
required: true
type: string
paramType: form
- name: owner
description: owner email, default is current admin
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
transfer a library
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string owner: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: owner
description: owner email
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
delete a library
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
type: Authorization: required: true type: string repo_id: required: true type: string path: required: true type: string dl: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: form
- name: path
description: Path
required: true
type: string
paramType: query
- name: dl
description: download
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string path: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: path
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
type: Authorization: required: true type: string repo_id: required: true type: string parent_dir: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: parent_dir
description: default "/"
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string parent_dir: required: false type: string obj_name: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: parent_dir
required: false
type: string
paramType: formData
- name: obj_name
required: true
type: string
paramType: formDataresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
type: Authorization: required: true type: string repo_id: required: true type: string password: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: password
description: Repo Password
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string message: required: true type: string primary: required: true type: boolean
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: message
description: notification message
required: true
type: string
paramType: formData
- name: primary
description: is notification the default one?
required: false
type: boolean
paramType: formDataresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: notification_id
description: id of notification
required: true
type: string
paramType: formData
- name: message
description: notification message
required: true
type: string
paramType: body
- name: primary
description: set current notification as primary or not
required: true
type: boolean
paramType: formDataresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| notification_id required | string |
OK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: notification_id
description: id of notification
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| notification_id required | string |
No Content
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: from
required: false
type: string
paramType: query
description: web or api. Default to web
- name: path
required: false
type: string
paramType: query
description: path for upload. Default to /responseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
OK
restore a deleted library
Permission checking:
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| repo_id required | string |
OK
permanently delete a deleted library
Permission checking:
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| repo_id required | string |
No Content
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
description: upload link token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
No Content
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
description: download link token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
No Content
Remove group from groupadmin page. Only system admin can perform this
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
description: group id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
No Content
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
description: new owner email
required: true
type: string
paramType: formData
- name: repo_id
description: id of the transfered repo
required: true
type: string
paramType: formDataresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
description: upload link token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
No Content
type: Authorization: required: true type: string page: required: true type: string per_page: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
OK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
OK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| user_email required | string |
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
OK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
OK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| user_email required | string |
OK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
description: user email
required: false
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| user_email required | string |
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
description: user email
required: false
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| user_email required | string |
No Content
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| user_email required | string |
Created
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
| user_email required | string |
Created
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: username: required: true type: string password: required: true type: string
parameters:
- name: login
required: true
type: string
paramType: form
description: login id or password
- name: password
required: true
type: string
paramType: form
- name: captcha_0
required: false
type: string
paramType: form
- name: captcha_1
required: false
type: string
paramType: form
- name: remember_me
required: false
type: number
paramType: form
description: 0 or 1. Default to 0responseMessages:
- code: 400
message: BAD REQUEST
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string group_id: required: true type: string size: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: size
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| size required | string |
OK
type: Authorization: required: true type: string user: required: true type: string size: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: user
required: true
type: string
paramType: path
- name: size
required: true
type: string
paramType: pathresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| user required | string |
| size required | string |
OK
Copy/move file/dir, and return task id.
Permission checking:
type: Authorization: required: true type: string src_repo_id: required: true type: string src_parent_dir: required: true type: string src_dirent_name: required: true type: string dst_repo_id: required: true type: string dst_parent_dir: required: true type: string operation: required: true type: string dirent_type: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: src_repo_id
required: true
type: string
paramType: form
- name: src_parent_dir
required: true
type: string
paramType: form
- name: src_dirent_name
required: true
type: string
paramType: form
- name: dst_repo_id
required: true
type: string
paramType: form
- name: dst_parent_dir
required: true
type: string
paramType: form
- name: operation
required: true
type: string
paramType: form
- name: dirent_type
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string task_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: task_id
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: notification_id
description: id of notification
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: token: required: true type: string p: required: false type: string mode: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: p
required: false
type: string
paramType: query
- name: mode
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
type: token: required: true type: string p: required: false type: string mode: required: false type: string password: required: false type: string email: required: false type: string code: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: p
required: false
type: string
paramType: query
- name: mode
required: false
type: string
paramType: query
- name: password
required: false
type: string
paramType: form
- name: email
required: false
type: string
paramType: form
- name: code
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
Created
type: Authorization: required: true type: string token: required: true type: string p: required: true type: string password: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
description: Upload link token
required: true
type: string
paramType: path
- name: p
description: Sub folder path
required: true
type: string
paramType: query
- name: password
description: If link is encrypted
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
type: token: required: true type: string p: required: false type: string dl: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: p
required: false
type: string
paramType: query
- name: dl
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
type: token: required: true type: string p: required: false type: string dl: required: false type: string password: required: false type: string email: required: false type: string code: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: p
required: false
type: string
paramType: query
- name: dl
required: false
type: string
paramType: query
- name: password
required: false
type: string
paramType: form
- name: email
required: false
type: string
paramType: form
- name: code
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
Created
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Restore deleted-repo return: return True if success, otherwise api_error
type: Authorization: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
List user's devices.
Permission checking:
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string platform: required: false type: string device_id: required: false type: string wipe_device: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: platform
required: false
type: string
paramType: query
- name: device_id
required: false
type: string
paramType: query
- name: wipe_device
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
Get File Activities This api will only return first 15 records of activities. if want get more, pass start parameter
type: Authorization: required: true type: string start: required: false type: string size: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: start
description: default 0
required: false
type: string
paramType: query
- name: size
description: size of user avatar, default 36
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
View file via shared link.
Download share file if dl in request param.
View raw share file if raw in request param.
type: token: required: true type: string op: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: op
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
View file via shared link.
Download share file if dl in request param.
View raw share file if raw in request param.
type: token: required: true type: string op: required: false type: string password: required: false type: string email: required: false type: string code: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: op
required: false
type: string
paramType: query
- name: password
required: false
type: string
paramType: form
- name: email
required: false
type: string
paramType: form
- name: code
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
Created
type: Authorization: required: true type: string from: required: false type: string name: required: true type: string desc: required: false type: string repo_id: required: true type: string
responseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string avatar_size: required: false type: string with_repos: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: avatar_size
required: false
type: string
paramType: query
- name: with_repos
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZEDconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string name: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: name
description: Name of new group
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string group_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string name: required: false type: string owner: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
description: Group ID
required: true
type: string
paramType: path
- name: name
description: Name of new group
required: false
type: string
paramType: form
- name: owner
description: New owner of this group, should be an email
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
description: Group ID
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
No Content
type: Authorization: required: true type: string group_id: required: true type: string page: required: false type: integer per_page: required: false type: integer avatar_size: required: false type: integer
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: page
description: (default 1)
required: false
type: integer
paramType: form
- name: per_page
description: (default 20)
required: false
type: integer
paramType: form
- name: avatar_size
description: (default 80)
required: false
type: integer
paramType: formresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string content: required: true type: string avatar_size: required: false type: integer
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: content
required: true
type: string
paramType: form
- name: avatar_size
required: false
type: integer
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
Created
Remove a group discussion.
type: Authorization: required: true type: string group_id: required: true type: string discuss_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: discuss_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| discuss_id required | string |
| group_id required | string |
No Content
type: Authorization: required: true type: string group_id: required: true type: string avatar_size: required: false type: integer is_admin: required: false type: boolean
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: avatar_size
required: false
type: integer
paramType: form
- name: is_admin
description: true or false, if ONLY return admin members of group. default false return all members
required: false
type: boolean
paramType: formresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
Created
type: Authorization: required: true type: string group_id: required: true type: string emails: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: emails
required: true
type: string
paramType: formresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
Created
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string avatar_size: required: false type: integer
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: path
- name: avatar_size
required: false
type: integer
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| email required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string is_admin: required: true type: boolean
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: path
- name: is_admin
required: true
type: boolean
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| email required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: email
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
| email required | string |
No Content
type: Authorization: required: true type: string group_id: required: true type: string from: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: from
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string group_id: required: true type: string name: required: true type: string desc: required: false type: string passwd: required: false type: string permission: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: name
required: true
type: string
paramType: form
- name: desc
required: false
type: string
paramType: form
- name: passwd
required: false
type: string
paramType: form
- name: permission
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
Created
type: Authorization: required: true type: string group_id: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: group_id
required: true
type: string
paramType: path
- name: repo_id
required: true
type: string
paramType: pathresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
| group_id required | string |
No Content
type: Authorization: required: true type: string q: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: q
description: Keyword to search
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| group_id required | string |
OK
type: Authorization: required: true type: string from: required: false type: string name: required: true type: string desc: required: false type: string repo_id: required: true type: string
responseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
currently only used for mark a notification seen
Permission checking:
type: Authorization: required: true type: string notification_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: notification_id
description: Notification ID
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string offset: required: false type: string limit: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: offset
required: false
type: string
paramType: query
- name: limit
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
currently only used for mark all notifications seen
Permission checking:
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
currently only used for get unseen notifications count
Permission checking:
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Get user's notifications.
If unseen notices > 5, return all unseen notices. If unseen notices = 0, return last 5 notices. Otherwise return all unseen notices, plus some seen notices to make the sum equal to 5.
Permission checking:
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: email: required: true type: string
parameters:
- name: email
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: uidb36: required: true type: string token: required: true type: string
parameters:
- name: uidb36
required: true
type: string
paramType: path
- name: token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| uidb36 required | string |
| token required | string |
OK
type: uidb36: required: true type: string token: required: true type: string new_password1: required: true type: string new_password2: required: true type: string
parameters:
- name: uidb36
required: true
type: string
paramType: path
- name: token
required: true
type: string
paramType: path
- name: new_password1
required: true
type: string
paramType: form
- name: new_password2
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| uidb36 required | string |
| token required | string |
Created
Returns a simple pong message when client calls api2/ping/.
For example:
curl http://127.0.0.1:8000/api3/ping/
OK
type: Authorization: required: true type: string avatar_size: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: avatar_size
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string nickname: required: false type: string intro: required: false type: string department: required: false type: string telephone: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: nickname
description: Name
required: false
type: string
paramType: form
- name: intro
description: Intro
required: false
type: string
paramType: form
- name: department
description: Department
required: false
type: string
paramType: form
- name: telephone
description: Telephone
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string nickname: required: false type: string intro: required: false type: string department: required: false type: string telephone: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: language
description: Language code
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string avatar: required: true type: file
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: avatar
required: true
type: file
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string old_password: required: true type: string new_password1: required: true type: string new_password2: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: old_password
required: true
type: string
paramType: form
- name: new_password1
required: true
type: string
paramType: form
- name: new_password2
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| old_password required | string |
| new_password1 required | string |
| new_password2 required | string |
Created
Fetch progress of file/dir mv/cp.
Permission checking:
type: Authorization: required: true type: string task_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: task_id
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: token: required: true type: string
parameters:
- name: token
description: Download token
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string start: required: true type: string limit: required: true type: string scope: required: false type: string
parameters:
responseMessages:
consumes:
Created
type: Authorization: required: true type: string repo_id: required: true type: string obj_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: obj_id
description: Revision file ID
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
| obj_id required | string |
OK
type: Authorization: required: true type: string type: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: type
description:
mine, get my owned libraries.
shared, get libraries shared to me.
group, get group libraries.
org, get public libraires.
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string name: required: true type: string desc: required: true type: string passwd: required: true type: string permission: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: name
required: true
type: string
paramType: form
- name: desc
required: false
type: string
paramType: form
- name: passwd
required: false
type: string
paramType: form
- name: permission
description: r or rw, default r
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string op: required: false type: string repo_name: required: false type: string repo_desc: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: op
required: false
type: string
paramType: query
- name: repo_name
required: false
type: string
paramType: form
- name: repo_desc
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
type: Authorization: required: true type: string repo_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
Get dir info.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string oid: required: false type: string t: required: false type: string recursive: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: The path to a directory. If p is missing, then defaults to '/' which is the top directory.
required: true
type: string
paramType: query
- name: oid
description: The object id of the directory. The object id is the checksum of the directory contents.
required: false
type: string
paramType: query
- name: t
description: If set t argument as f, will only return file entries, and d for only dir entries.
required: false
type: string
paramType: query
- name: recursive
description: If set t argument as d AND recursive argument as 1, return all dir entries recursively
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Create, rename, revert dir.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string operation: required: true type: string newname: required: false type: string commit_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: operation
description: mkdir or rename
required: true
type: string
paramType: form
- name: newname
description: The new name of the directory
required: false
type: string
paramType: form
- name: commit_id
description: The commit id to revert
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Delete dir.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
Get dir info.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string path: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: path
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string path: required: true type: string dir_only: required: false type: boolean all_dir: required: false type: boolean
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: path
required: true
type: string
paramType: query
- name: dir_only
required: false
type: boolean
paramType: query
- name: all_dir
required: false
type: boolean
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string parent_dir: required: true type: string dirents_names: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: parent_dir
required: true
type: string
paramType: query
- name: dirents_names
description: multiple file/folder names
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Get file info.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Create, rename, move, copy, revert file
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string operation: required: true type: string newname: required: false type: string dst_repo: required: false type: string dst_dir: required: false type: string commit_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: operation
description: create, rename, move, copy, revert
required: true
type: string
paramType: form
- name: newname
required: false
type: string
paramType: form
- name: dst_repo
required: false
type: string
paramType: form
- name: dst_dir
required: false
type: string
paramType: form
- name: commit_id
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Currently only for lock and unlock file operation.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string operation: required: true type: string expire: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: operation
description: lock or unlock
required: true
type: string
paramType: form
- name: expire
description: File lock expiration days
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Delete file.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string avatar_size: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: avatar_size
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string avatar_size: required: true type: string comment: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: avatar_size
required: false
type: string
paramType: query
- name: comment
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string pk: required: true type: string avatar_size: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: pk
description: Comment ID
required: true
type: string
paramType: path
- name: avatar_size
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
| id required | string |
OK
Delete a comment, only comment author or repo owner can perform
type: Authorization: required: true type: string repo_id: required: true type: string pk: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: pk
description: Comment ID
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
| id required | string |
No Content
type: Authorization: required: true type: string repo_id: required: true type: string path: required: true type: string commit_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: path
required: true
type: string
paramType: query
- name: commit_id
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string file_enc: required: false type: string from: required: false type: string gid: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: file_enc
description: File encoding, default auto
required: false
type: string
paramType: query
- name: from
required: false
type: string
paramType: query
- name: gid
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string content: required: true type: string encoding: required: true type: string head: required: true type: string from: required: false type: string gid: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: content
description: File content
required: true
type: string
paramType: form
- name: encoding
description: File encoding, default auto
required: true
type: string
paramType: form
- name: head
required: true
type: string
paramType: query
- name: from
required: false
type: string
paramType: query
- name: gid
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Steps to view file:
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string dl: required: false type: string raw: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: dl
description: Download
required: false
type: string
paramType: query
- name: raw
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string commit_id: required: true type: string obj_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: commit_id
description: Commit ID
required: true
type: string
paramType: query
- name: obj_id
description: File revision ID
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string days: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: days
description: default 7
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string commit: required: true type: string p: required: true type: string file_enc: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: commit
description: Commit ID
required: true
type: string
paramType: query
- name: p
description: Path
required: true
type: string
paramType: query
- name: file_enc
description: File encoding (auto, utf-8, gbk, ISO-8859-1, ISO-8859-5) (default is auto)
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
List repo group folder perms (by folder_path).
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Add repo group folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string permission: required: false type: string group_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: form
- name: permission
required: false
type: string
paramType: form
- name: group_id
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Modify repo group folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string permission: required: false type: string group_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: form
- name: permission
required: false
type: string
paramType: form
- name: group_id
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Remove repo group folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string group_id: required: false type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: group_id
required: false
type: string
paramType: form
- name: folder_path
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
Return history of library
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string page: required: false type: string per_page: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: page
description: default 1
required: false
type: string
paramType: query
- name: per_page
description: default 100
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string commit_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: commit_id
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: false type: string commit_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
required: false
type: string
paramType: query
- name: commit_id
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string commit_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: commit_id
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string password: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: password
description: Repo Password
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Change repo password.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string old_password: required: true type: string new_password: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: old_password
description: Old password
required: true
type: string
paramType: form
- name: new_password
description: New password
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string size: required: true type: string obj_id: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
required: true
type: string
paramType: query
- name: size
required: true
type: string
paramType: query
- name: obj_id
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string commit_id: required: false type: string base: required: false type: string p: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: commit_id
required: false
type: string
paramType: query
- name: base
required: false
type: string
paramType: query
- name: p
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string day: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: keep_days
description: -1 (all), 3, 7, 30
required: true
type: string
paramType: formresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
type: Authorization: required: true type: string dir_path: required: false type: string commit_id: required: false type: string base: required: false type: string p: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: dir_path
required: false
type: string
paramType: query
- name: commit_id
required: false
type: string
paramType: query
- name: base
required: false
type: string
paramType: query
- name: p
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string commit_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: form
- name: commit_id
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string obj_id: required: true type: string commit_id: required: true type: string p: required: true type: string base: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: obj_id
required: true
type: string
paramType: query
- name: commit_id
required: true
type: string
paramType: query
- name: p
required: true
type: string
paramType: query
- name: base
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string commit_id: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: form
- name: commit_id
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string path: required: false type: string show_days: required: false type: string scan_stat: required: false type: string limit: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: path
required: false
type: string
paramType: query
- name: show_days
required: false
type: string
paramType: query
- name: scan_stat
required: false
type: string
paramType: query
- name: limit
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string from: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: p
description: Path
required: true
type: string
paramType: query
- name: from
description: api or web
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
List repo user folder perms (by folder_path).
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Add repo user folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string permission: required: false type: string user_email: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: form
- name: permission
required: false
type: string
paramType: form
- name: user_email
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
Created
Modify repo user folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string folder_path: required: false type: string permission: required: false type: string user_email: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: folder_path
required: false
type: string
paramType: form
- name: permission
required: false
type: string
paramType: form
- name: user_email
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
Remove repo user folder perm.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string user_email: required: false type: string folder_path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: user_email
required: false
type: string
paramType: form
- name: folder_path
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
No Content
Get file server token for download-dir and download-multi.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string parent_dir: required: false type: string dirents: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: path
- name: parent_dir
required: false
type: string
paramType: query
- name: dirents
required: false
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| repo_id required | string |
OK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Search group.
Permission checking:
type: Authorization: required: true type: string q: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: q
description: Keyword to search
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string q: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: q
description: Keyword to search
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string token: required: true type: string email: required: true type: string extra_msg: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
required: true
type: string
paramType: form
- name: email
required: true
type: string
paramType: form
- name: extra_msg
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
Get constance settings by keys.
The valid system setting keys are: DISABLE_SYNC_WITH_ANY_FOLDER, ENABLE_USER_CREATE_ORG_REPO, SHARE_LINK_TOKEN_LENGTH, ENABLE_GLOBAL_ADDRESSBOOK, REPO_PASSWORD_MIN_LENGTH, REGISTRATION_SEND_MAIL, SHARE_LINK_PASSWORD_MIN_LENGTH, ENABLE_REPO_HISTORY_SETTING, SERVICE_URL, ACTIVATE_AFTER_REGISTRATION, ENABLE_ENCRYPTED_LIBRARY, LOGIN_REMEMBER_DAYS, USER_STRONG_PASSWORD_REQUIRED, FORCE_PASSWORD_CHANGE, FREEZE_USER_ON_LOGIN_FAILED, ENABLE_TWO_FACTOR_AUTH, USER_PASSWORD_MIN_LENGTH, TEXT_PREVIEW_EXT, ENABLE_SIGNUP, USER_PASSWORD_STRENGTH_LEVEL, FILE_SERVER_ROOT, LOGIN_ATTEMPT_LIMIT
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: keys
required: true
type: string
paramType: query
description: a string contains the setting keys for retrieve seperate by comma.responseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Get restapi settings by keys.
The valid system setting keys are: CLOUD_MODE
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: keys
required: true
type: string
paramType: query
description: a string contains the setting keys for retrieve seperate by comma.responseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: form
- name: p
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: Authorization: required: true type: string repo_id: required: true type: string p: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: query
- name: p
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonNo Content
List admin settings.
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Update admin settings
type: Authorization: required: true type: string key: required: true type: string value: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: key
description: setting key
required: true
type: string
paramType: form
- name: value
description: setting value
required: true
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
type: token: required: true type: string
parameters:
- name: token
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
type: token: required: true type: string password: required: false type: string email: required: false type: string code: required: false type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: password
required: false
type: string
paramType: form
- name: email
required: false
type: string
paramType: form
- name: code
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
Created
Get file upload url in dir upload link.
Arguments:
request:token:type: token: required: true type: string repo_id: required: true type: string
parameters:
- name: token
required: true
type: string
paramType: path
- name: repo_id
required: true
type: string
paramType: queryresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
type: Authorization: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: headerresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Get all upload links of a user.
Permission checking:
type: Authorization: required: true type: string repo_id: required: false type: string path: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: false
type: string
paramType: query
- name: path
required: false
type: string
paramType: queryresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonOK
Create upload link.
Permission checking:
type: Authorization: required: true type: string repo_id: required: true type: string path: required: false type: string password: required: false type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: repo_id
required: true
type: string
paramType: form
- name: path
required: false
type: string
paramType: form
- name: password
required: false
type: string
paramType: formresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/jsonCreated
Get upload link info.
Permission checking:
type: Authorization: required: true type: string token: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
required: true
type: string
paramType: pathresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
OK
Delete upload link.
Permission checking:
type: Authorization: required: true type: string token: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: token
required: true
type: string
paramType: pathresponseMessages:
- code: 401
message: UNAUTHORIZED
- code: 403
message: FORBIDDEN
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| token required | string |
No Content
type: Authorization: required: true type: string email: required: true type: string
parameters:
- name: Authorization
required: true
type: string
paramType: header
- name: email
description: User email
required: true
type: string
paramType: pathresponseMessages:
- code: 400
message: BAD_REQUEST
- code: 401
message: UNAUTHORIZED
- code: 404
message: NOT_FOUND
- code: 500
message: INTERNAL_SERVER_ERRORconsumes:
- application/jsonproduces:
- application/json| email required | string |
OK