Syncwerk API ()

Download OpenAPI specification:Download

Authentication

basic

Security scheme type: HTTP
HTTP Authorization Scheme basic

api

api_v2.1_address-book_groups_search-member_list

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/address-book/groups/{group_id}/search-member/
/api/v2.1/address-book/groups/{group_id}/search-member/

api_v2.1_address-book_groups_sub-groups_list

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/address-book/groups/{group_id}/sub-groups/
/api/v2.1/address-book/groups/{group_id}/sub-groups/

List top groups in address book.

List top groups in address book.

Responses

200

OK

get /api/v2.1/admin/address-book/groups/
/api/v2.1/admin/address-book/groups/

Add a group in address book.

Add a group in address book.

parent_group: -1 - no parent group; > 0 - have parent group. group_owner: default to system admin group_staff: default to system admin

Responses

201

Created

post /api/v2.1/admin/address-book/groups/
/api/v2.1/admin/address-book/groups/

List child groups and members in an address book group.

List child groups and members in an address book group.

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/admin/address-book/groups/{group_id}/
/api/v2.1/admin/address-book/groups/{group_id}/

Delete an address book group.

Delete an address book group.

path Parameters
group_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/address-book/groups/{group_id}/
/api/v2.1/admin/address-book/groups/{group_id}/

api_v2.1_admin_admin-login-logs_list

Responses

200

OK

get /api/v2.1/admin/admin-login-logs/
/api/v2.1/admin/admin-login-logs/

List all logs

List all logs

Permission checking:

  1. Admin user;

Responses

200

OK

get /api/v2.1/admin/admin-logs/
/api/v2.1/admin/admin-logs/

Get role info of an admin user.

Get role info of an admin user.

Permission checking:

  1. only admin can perform this action.
  2. email(from argument): must be an admin user.

Responses

200

OK

get /api/v2.1/admin/admin-role/
/api/v2.1/admin/admin-role/

Add role for an admin user.

Add role for an admin user.

Argument checking:

  1. role: must be in get_available_admin_roles.

Permission checking:

  1. email(from argument): must be an admin user.
  2. only admin with default_admin role can perform this action.

Responses

201

Created

post /api/v2.1/admin/admin-role/
/api/v2.1/admin/admin-role/

Update role for an admin user.

Update role for an admin user.

Argument checking:

  1. role: must be in get_available_admin_roles.

Permission checking:

  1. email(from argument): must be an admin user.
  2. only admin with default_admin role can perform this action.

Responses

200

OK

put /api/v2.1/admin/admin-role/
/api/v2.1/admin/admin-role/

Get info of common user's default library.

Get info of common user's default library.

Permission checking:

  1. only admin can perform this action.

Responses

200

OK

get /api/v2.1/admin/default-library/
/api/v2.1/admin/default-library/

Create a default library for a common user.

Create a default library for a common user.

Permission checking:

  1. only admin can perform this action.

Responses

201

Created

post /api/v2.1/admin/default-library/
/api/v2.1/admin/default-library/

api_v2.1_admin_device-errors_list

Responses

200

OK

get /api/v2.1/admin/device-errors/
/api/v2.1/admin/device-errors/

api_v2.1_admin_device-errors_delete

Responses

204

No Content

delete /api/v2.1/admin/device-errors/
/api/v2.1/admin/device-errors/

api_v2.1_admin_device-trusted-ip_list

Responses

200

OK

get /api/v2.1/admin/device-trusted-ip/
/api/v2.1/admin/device-trusted-ip/

api_v2.1_admin_device-trusted-ip_create

Responses

201

Created

post /api/v2.1/admin/device-trusted-ip/
/api/v2.1/admin/device-trusted-ip/

api_v2.1_admin_device-trusted-ip_delete

Responses

204

No Content

delete /api/v2.1/admin/device-trusted-ip/
/api/v2.1/admin/device-trusted-ip/

api_v2.1_admin_devices_list

Responses

200

OK

get /api/v2.1/admin/devices/
/api/v2.1/admin/devices/

api_v2.1_admin_devices_delete

Responses

204

No Content

delete /api/v2.1/admin/devices/
/api/v2.1/admin/devices/

api_v2.1_admin_favicon_create

Responses

201

Created

post /api/v2.1/admin/favicon/
/api/v2.1/admin/favicon/

List all groups / search group by name

List all groups / search group by name

Permission checking:

  1. Admin user;

Responses

200

OK

get /api/v2.1/admin/groups/
/api/v2.1/admin/groups/

Create a group

Create a group

Permission checking:

  1. Admin user;

Responses

201

Created

post /api/v2.1/admin/groups/
/api/v2.1/admin/groups/

Admin update a group

Admin update a group

  1. transfer a group.
  2. set group quota

Permission checking:

  1. Admin user;
path Parameters
group_id
required
string

Responses

200

OK

put /api/v2.1/admin/groups/{group_id}/
/api/v2.1/admin/groups/{group_id}/

Dismiss a specific group

Dismiss a specific group

path Parameters
group_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/groups/{group_id}/
/api/v2.1/admin/groups/{group_id}/

api_v2.1_admin_groups_group-owned-libraries_create

path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/admin/groups/{group_id}/group-owned-libraries/
/api/v2.1/admin/groups/{group_id}/group-owned-libraries/

api_v2.1_admin_groups_group-owned-libraries_delete

path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/groups/{group_id}/group-owned-libraries/{repo_id}/
/api/v2.1/admin/groups/{group_id}/group-owned-libraries/{repo_id}/

List all group repos

List all group repos

Permission checking:

  1. only admin can perform this action.
path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/admin/groups/{group_id}/libraries/
/api/v2.1/admin/groups/{group_id}/libraries/

Unshare repo from group

Unshare repo from group

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/groups/{group_id}/libraries/{repo_id}/
/api/v2.1/admin/groups/{group_id}/libraries/{repo_id}/

List all group members

List all group members

Permission checking:

  1. only admin can perform this action.
path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/admin/groups/{group_id}/members/
/api/v2.1/admin/groups/{group_id}/members/

Bulk add group members.

Bulk add group members.

Permission checking:

  1. only admin can perform this action.
path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/admin/groups/{group_id}/members/
/api/v2.1/admin/groups/{group_id}/members/

update role of a group member

update role of a group member

Permission checking:

  1. only admin can perform this action.
path Parameters
group_id
required
string
email
required
string

Responses

200

OK

put /api/v2.1/admin/groups/{group_id}/members/{email}/
/api/v2.1/admin/groups/{group_id}/members/{email}/

Delete an user from group

Delete an user from group

Permission checking:

  1. only admin can perform this action.
path Parameters
group_id
required
string
email
required
string

Responses

204

No Content

delete /api/v2.1/admin/groups/{group_id}/members/{email}/
/api/v2.1/admin/groups/{group_id}/members/{email}/

api_v2.1_admin_invitations_delete

Responses

204

No Content

delete /api/v2.1/admin/invitations/
/api/v2.1/admin/invitations/

List 'all' libraries (by name/owner/page)

List 'all' libraries (by name/owner/page)

Permission checking:

  1. only admin can perform this action.

Responses

200

OK

get /api/v2.1/admin/libraries/
/api/v2.1/admin/libraries/

Admin create library

Admin create library

Permission checking:

  1. only admin can perform this action.

Responses

201

Created

post /api/v2.1/admin/libraries/
/api/v2.1/admin/libraries/

get info of a library

get info of a library

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/admin/libraries/{repo_id}/
/api/v2.1/admin/libraries/{repo_id}/

transfer a library

transfer a library

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/admin/libraries/{repo_id}/
/api/v2.1/admin/libraries/{repo_id}/

delete a library

delete a library

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/libraries/{repo_id}/
/api/v2.1/admin/libraries/{repo_id}/

api_v2.1_admin_libraries_dirent_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/admin/libraries/{repo_id}/dirent/
/api/v2.1/admin/libraries/{repo_id}/dirent/

api_v2.1_admin_libraries_dirent_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/admin/libraries/{repo_id}/dirent/
/api/v2.1/admin/libraries/{repo_id}/dirent/

api_v2.1_admin_libraries_dirent_delete

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/libraries/{repo_id}/dirent/
/api/v2.1/admin/libraries/{repo_id}/dirent/

api_v2.1_admin_libraries_dirents_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/admin/libraries/{repo_id}/dirents/
/api/v2.1/admin/libraries/{repo_id}/dirents/

api_v2.1_admin_libraries_dirents_create

path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/admin/libraries/{repo_id}/dirents/
/api/v2.1/admin/libraries/{repo_id}/dirents/

api_v2.1_admin_libraries_history-limit_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/admin/libraries/{repo_id}/history-limit/
/api/v2.1/admin/libraries/{repo_id}/history-limit/

api_v2.1_admin_libraries_history-limit_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/admin/libraries/{repo_id}/history-limit/
/api/v2.1/admin/libraries/{repo_id}/history-limit/

api_v2.1_admin_license_create

Responses

201

Created

post /api/v2.1/admin/license/
/api/v2.1/admin/license/

api_v2.1_admin_login-background-image_create

Responses

201

Created

post /api/v2.1/admin/login-background-image/
/api/v2.1/admin/login-background-image/

api_v2.1_admin_logo_create

Responses

201

Created

post /api/v2.1/admin/logo/
/api/v2.1/admin/logo/

Get base info of a organization

Get base info of a organization

Permission checking:

  1. only admin can perform this action.
path Parameters
org_id
required
string

Responses

200

OK

get /api/v2.1/admin/organizations/{org_id}/
/api/v2.1/admin/organizations/{org_id}/

Update base info of a organization

Update base info of a organization

Permission checking:

  1. only admin can perform this action.
path Parameters
org_id
required
string

Responses

200

OK

put /api/v2.1/admin/organizations/{org_id}/
/api/v2.1/admin/organizations/{org_id}/

Delete an organization

Delete an organization

Permission checking:

  1. only admin can perform this action.
path Parameters
org_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/organizations/{org_id}/
/api/v2.1/admin/organizations/{org_id}/

api_v2.1_admin_organizations_statistics_traffic_list

path Parameters
org_id
required
string

Responses

200

OK

get /api/v2.1/admin/organizations/{org_id}/statistics/traffic/
/api/v2.1/admin/organizations/{org_id}/statistics/traffic/

Add new user to org.

Add new user to org.

Permission checking:

  1. only admin can perform this action.
path Parameters
org_id
required
string

Responses

201

Created

post /api/v2.1/admin/organizations/{org_id}/users/
/api/v2.1/admin/organizations/{org_id}/users/

api_v2.1_admin_organizations_users_read

path Parameters
org_id
required
string
email
required
string

Responses

200

OK

get /api/v2.1/admin/organizations/{org_id}/users/{email}/
/api/v2.1/admin/organizations/{org_id}/users/{email}/

api_v2.1_admin_organizations_users_update

path Parameters
org_id
required
string
email
required
string

Responses

200

OK

put /api/v2.1/admin/organizations/{org_id}/users/{email}/
/api/v2.1/admin/organizations/{org_id}/users/{email}/

api_v2.1_admin_organizations_users_delete

path Parameters
org_id
required
string
email
required
string

Responses

204

No Content

delete /api/v2.1/admin/organizations/{org_id}/users/{email}/
/api/v2.1/admin/organizations/{org_id}/users/{email}/

api_v2.1_admin_revision-tags_tagged-items_list

Responses

200

OK

get /api/v2.1/admin/revision-tags/tagged-items/
/api/v2.1/admin/revision-tags/tagged-items/

api_v2.1_admin_shares_list

Responses

200

OK

get /api/v2.1/admin/shares/
/api/v2.1/admin/shares/

api_v2.1_admin_shares_create

Responses

201

Created

post /api/v2.1/admin/shares/
/api/v2.1/admin/shares/

api_v2.1_admin_shares_update

Responses

200

OK

put /api/v2.1/admin/shares/
/api/v2.1/admin/shares/

api_v2.1_admin_shares_delete

Responses

204

No Content

delete /api/v2.1/admin/shares/
/api/v2.1/admin/shares/

api_v2.1_admin_statistics_active-users_list

Responses

200

OK

get /api/v2.1/admin/statistics/active-users/
/api/v2.1/admin/statistics/active-users/

Get file operations statistics.

Get file operations statistics. Permission checking:

  1. only admin can perform this action.

Responses

200

OK

get /api/v2.1/admin/statistics/file-operations/
/api/v2.1/admin/statistics/file-operations/

api_v2.1_admin_statistics_system-traffic_list

Responses

200

OK

get /api/v2.1/admin/statistics/system-traffic/
/api/v2.1/admin/statistics/system-traffic/

api_v2.1_admin_statistics_total-storage_list

Responses

200

OK

get /api/v2.1/admin/statistics/total-storage/
/api/v2.1/admin/statistics/total-storage/

Show system info.

Show system info.

Responses

200

OK

get /api/v2.1/admin/sysinfo/
/api/v2.1/admin/sysinfo/

api_v2.1_admin_system-library_list

Responses

200

OK

get /api/v2.1/admin/system-library/
/api/v2.1/admin/system-library/

List deleted repos (by owner)

List deleted repos (by owner)

Permission checking:

  1. only admin can perform this action.

Responses

200

OK

get /api/v2.1/admin/trash-libraries/
/api/v2.1/admin/trash-libraries/

restore a deleted library

restore a deleted library

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/admin/trash-libraries/{repo_id}/
/api/v2.1/admin/trash-libraries/{repo_id}/

permanently delete a deleted library

permanently delete a deleted library

Permission checking:

  1. only admin can perform this action.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/admin/trash-libraries/{repo_id}/
/api/v2.1/admin/trash-libraries/{repo_id}/

api_v2.1_admin_users_list

Responses

200

OK

get /api/v2.1/admin/users/
/api/v2.1/admin/users/

api_v2.1_admin_users_create

Responses

201

Created

post /api/v2.1/admin/users/
/api/v2.1/admin/users/

Set user quota, set user tenant, delete users, in batch.

Set user quota, set user tenant, delete users, in batch.

Permission checking:

  1. admin user.

Responses

201

Created

post /api/v2.1/admin/users/batch/
/api/v2.1/admin/users/batch/

api_v2.1_admin_users_read

path Parameters
email
required
string

Responses

200

OK

get /api/v2.1/admin/users/{email}/
/api/v2.1/admin/users/{email}/

api_v2.1_admin_users_update

path Parameters
email
required
string

Responses

200

OK

put /api/v2.1/admin/users/{email}/
/api/v2.1/admin/users/{email}/

api_v2.1_admin_users_delete

path Parameters
email
required
string

Responses

204

No Content

delete /api/v2.1/admin/users/{email}/
/api/v2.1/admin/users/{email}/

List all groups in system.

List all groups in system.

Responses

200

OK

get /api/v2.1/all-groups/
/api/v2.1/all-groups/

stop progress when download dir/multi.

stop progress when download dir/multi. Permission checking:

Responses

201

Created

post /api/v2.1/cancel-zip-task/
/api/v2.1/cancel-zip-task/

Copy/move file/dir, and return task id.

Copy/move file/dir, and return task id.

Permission checking:

  1. move: user with 'rw' permission for current file, 'rw' permission for dst parent dir;
  2. copy: user with 'r' permission for current file, 'rw' permission for dst parent dir;

Responses

201

Created

post /api/v2.1/copy-move-task/
/api/v2.1/copy-move-task/

Cancel file/dir mv/cp.

Cancel file/dir mv/cp.

Permission checking:

  1. user login;

Responses

204

No Content

delete /api/v2.1/copy-move-task/
/api/v2.1/copy-move-task/

get the deleted-repos of owner

get the deleted-repos of owner

Responses

200

OK

get /api/v2.1/deleted-repos/
/api/v2.1/deleted-repos/

restore deleted-repo

restore deleted-repo return: return True if success, otherwise api_error

Responses

201

Created

post /api/v2.1/deleted-repos/
/api/v2.1/deleted-repos/

List repo group folder perms (by folder_path).

List repo group folder perms (by folder_path).

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/

Add repo group folder perm.

Add repo group folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/

Modify repo group folder perm.

Modify repo group folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/

Delete repo group folder perm.

Delete repo group folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/group-folder-permission/

List repo group share info.

List repo group share info.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/group-owned-libraries/{repo_id}/group-share/
/api/v2.1/group-owned-libraries/{repo_id}/group-share/

api_v2.1_group-owned-libraries_group-share_create

path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/group-owned-libraries/{repo_id}/group-share/
/api/v2.1/group-owned-libraries/{repo_id}/group-share/

api_v2.1_group-owned-libraries_group-share_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/group-owned-libraries/{repo_id}/group-share/
/api/v2.1/group-owned-libraries/{repo_id}/group-share/

api_v2.1_group-owned-libraries_group-share_delete

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/group-owned-libraries/{repo_id}/group-share/
/api/v2.1/group-owned-libraries/{repo_id}/group-share/

List repo user folder perms (by folder_path).

List repo user folder perms (by folder_path).

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/

Add repo user folder perm.

Add repo user folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/

Modify repo user folder perm.

Modify repo user folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/

Delete repo user folder perm.

Delete repo user folder perm.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/
/api/v2.1/group-owned-libraries/{repo_id}/user-folder-permission/

List repo user share info.

List repo user share info.

Permission checking:

  1. is group admin
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/group-owned-libraries/{repo_id}/user-share/
/api/v2.1/group-owned-libraries/{repo_id}/user-share/

api_v2.1_group-owned-libraries_user-share_create

path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/group-owned-libraries/{repo_id}/user-share/
/api/v2.1/group-owned-libraries/{repo_id}/user-share/

api_v2.1_group-owned-libraries_user-share_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/group-owned-libraries/{repo_id}/user-share/
/api/v2.1/group-owned-libraries/{repo_id}/user-share/

api_v2.1_group-owned-libraries_user-share_delete

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/group-owned-libraries/{repo_id}/user-share/
/api/v2.1/group-owned-libraries/{repo_id}/user-share/

List all groups.

List all groups.

Responses

200

OK

get /api/v2.1/groups/
/api/v2.1/groups/

Create a group

Create a group

Responses

201

Created

post /api/v2.1/groups/
/api/v2.1/groups/

api_v2.1_groups_read

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/groups/{group_id}/
/api/v2.1/groups/{group_id}/

api_v2.1_groups_update

path Parameters
group_id
required
string

Responses

200

OK

put /api/v2.1/groups/{group_id}/
/api/v2.1/groups/{group_id}/

api_v2.1_groups_delete

path Parameters
group_id
required
string

Responses

204

No Content

delete /api/v2.1/groups/{group_id}/
/api/v2.1/groups/{group_id}/

api_v2.1_groups_group-owned-libraries_create

path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/groups/{group_id}/group-owned-libraries/
/api/v2.1/groups/{group_id}/group-owned-libraries/

api_v2.1_groups_group-owned-libraries_update

path Parameters
repo_id
required
string
group_id
required
string

Responses

200

OK

put /api/v2.1/groups/{group_id}/group-owned-libraries/{repo_id}/
/api/v2.1/groups/{group_id}/group-owned-libraries/{repo_id}/

api_v2.1_groups_group-owned-libraries_delete

path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api/v2.1/groups/{group_id}/group-owned-libraries/{repo_id}/
/api/v2.1/groups/{group_id}/group-owned-libraries/{repo_id}/

api_v2.1_groups_libraries_list

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/groups/{group_id}/libraries/
/api/v2.1/groups/{group_id}/libraries/

api_v2.1_groups_libraries_create

path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/groups/{group_id}/libraries/
/api/v2.1/groups/{group_id}/libraries/

api_v2.1_groups_libraries_delete

path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api/v2.1/groups/{group_id}/libraries/{repo_id}/
/api/v2.1/groups/{group_id}/libraries/{repo_id}/

api_v2.1_groups_members_list

path Parameters
group_id
required
string

Responses

200

OK

get /api/v2.1/groups/{group_id}/members/
/api/v2.1/groups/{group_id}/members/

api_v2.1_groups_members_create

path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/groups/{group_id}/members/
/api/v2.1/groups/{group_id}/members/

api_v2.1_groups_members_bulk_create

path Parameters
group_id
required
string

Responses

201

Created

post /api/v2.1/groups/{group_id}/members/bulk/
/api/v2.1/groups/{group_id}/members/bulk/

api_v2.1_groups_members_read

path Parameters
group_id
required
string
email
required
string

Responses

200

OK

get /api/v2.1/groups/{group_id}/members/{email}/
/api/v2.1/groups/{group_id}/members/{email}/

api_v2.1_groups_members_update

path Parameters
group_id
required
string
email
required
string

Responses

200

OK

put /api/v2.1/groups/{group_id}/members/{email}/
/api/v2.1/groups/{group_id}/members/{email}/

api_v2.1_groups_members_delete

path Parameters
group_id
required
string
email
required
string

Responses

204

No Content

delete /api/v2.1/groups/{group_id}/members/{email}/
/api/v2.1/groups/{group_id}/members/{email}/

api_v2.1_invitations_list

Responses

200

OK

get /api/v2.1/invitations/
/api/v2.1/invitations/

api_v2.1_invitations_create

Responses

201

Created

post /api/v2.1/invitations/
/api/v2.1/invitations/

api_v2.1_invitations_batch_create

Responses

201

Created

post /api/v2.1/invitations/batch/
/api/v2.1/invitations/batch/

api_v2.1_invitations_read

path Parameters
token
required
string

Responses

200

OK

get /api/v2.1/invitations/{token}/
/api/v2.1/invitations/{token}/

api_v2.1_invitations_delete

path Parameters
token
required
string

Responses

204

No Content

delete /api/v2.1/invitations/{token}/
/api/v2.1/invitations/{token}/

Only support move folder.

Only support move folder.

Permission checking:

User with 'rw' permission for src/dst folder.

Responses

201

Created

post /api/v2.1/move-folder-merge/
/api/v2.1/move-folder-merge/

currently only used for mark a notification seen

currently only used for mark a notification seen

Permission checking:

  1. login user.

Responses

200

OK

put /api/v2.1/notification/
/api/v2.1/notification/

currently only used for get unseen notifications count

currently only used for get unseen notifications count

Permission checking:

  1. login user.

Responses

200

OK

get /api/v2.1/notifications/
/api/v2.1/notifications/

currently only used for mark all notifications seen

currently only used for mark all notifications seen

Permission checking:

  1. login user.

Responses

200

OK

put /api/v2.1/notifications/
/api/v2.1/notifications/

Fetch progress of file/dir mv/cp.

Fetch progress of file/dir mv/cp.

Permission checking:

  1. user login;

Responses

200

OK

get /api/v2.1/query-copy-move-progress/
/api/v2.1/query-copy-move-progress/

check progress when download dir/multi.

check progress when download dir/multi.

Permission checking:

Responses

200

OK

get /api/v2.1/query-zip-progress/
/api/v2.1/query-zip-progress/

Multi copy folders.

Multi copy folders.

Permission checking:

  1. User must has r/rw permission for src folder.
  2. User must has 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/"}, ] }

Responses

201

Created

post /api/v2.1/repos/batch-copy-dir/
/api/v2.1/repos/batch-copy-dir/

Multi copy files/folders.

Multi copy files/folders. Permission checking:

  1. User must has r/rw permission for src folder.
  2. User must has 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/"},
    ] }

Responses

201

Created

post /api/v2.1/repos/batch-copy-item/
/api/v2.1/repos/batch-copy-item/

Multi create folders.

Multi create folders.

Permission checking:

  1. user with rw permission for every layer of subdirectories.

Parameter: { "repo_id": "4dfdf5b6-806f-4a35-b2b7-604051d2114e", "paths": ["/1/2/", "/3/4/", "/5/6"] }

Responses

201

Created

post /api/v2.1/repos/batch-create-dir/
/api/v2.1/repos/batch-create-dir/

Multi move files/folders.

Multi move files/folders. Permission checking:

  1. User must has rw permission for src folder.
  2. User must has 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/"},
    ] }

Responses

201

Created

post /api/v2.1/repos/batch-move-item/
/api/v2.1/repos/batch-move-item/

api_v2.1_repos_batch_create

Responses

201

Created

post /api/v2.1/repos/batch/
/api/v2.1/repos/batch/

Return repo info

Return repo info

Permission checking:

  1. all authenticated user can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/
/api/v2.1/repos/{repo_id}/

Get dir info.

Get dir info.

Permission checking:

  1. user with either 'r' or 'rw' permission.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/dir/
/api/v2.1/repos/{repo_id}/dir/

Create, rename, revert dir.

Create, rename, revert dir.

Permission checking:

  1. create: user with 'rw' permission for current dir's parent dir;
  2. rename: user with 'rw' permission for current dir;
  3. revert: user with 'rw' permission for current dir's parent dir;
path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/repos/{repo_id}/dir/
/api/v2.1/repos/{repo_id}/dir/

Delete dir.

Delete dir.

Permission checking:

  1. user with 'rw' permission.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/repos/{repo_id}/dir/
/api/v2.1/repos/{repo_id}/dir/

Get dir info.

Get dir info.

Permission checking:

  1. user with either 'r' or 'rw' permission.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/dir/detail/
/api/v2.1/repos/{repo_id}/dir/detail/

For resumable fileupload

For resumable fileupload

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/file-uploaded-bytes/
/api/v2.1/repos/{repo_id}/file-uploaded-bytes/

Get file info.

Get file info.

Permission checking:

  1. user with either 'r' or 'rw' permission.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/file/
/api/v2.1/repos/{repo_id}/file/

Create, rename, move, copy, revert file

Create, rename, move, copy, revert file

Permission checking:

  1. create: user with 'rw' permission for current parent dir;
  2. rename: user with 'rw' permission for current file;
  3. move : user with 'rw' permission for current file, 'rw' permission for dst parent dir;
  4. copy : user with 'r' permission for current file, 'rw' permission for dst parent dir;
  5. revert: user with 'rw' permission for current file's parent dir;
path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/repos/{repo_id}/file/
/api/v2.1/repos/{repo_id}/file/

Currently only support lock, unlock, refresh-lock file.

Currently only support lock, unlock, refresh-lock file.

Permission checking:

  1. user with 'rw' permission for current file;
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/repos/{repo_id}/file/
/api/v2.1/repos/{repo_id}/file/

Delete file.

Delete file.

Permission checking:

  1. user with 'rw' permission.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/repos/{repo_id}/file/
/api/v2.1/repos/{repo_id}/file/

Get file history within certain commits.

Get file history within certain commits.

Controlled by path(rev_renamed_old_path), commit_id and next_start_commit.

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/file/history/
/api/v2.1/repos/{repo_id}/file/history/

Return history of library

Return history of library

Permission checking:

  1. all authenticated user can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/history/
/api/v2.1/repos/{repo_id}/history/

Check if repo password is correct.

Check if repo password is correct.

Permission checking:

  1. User can access current repo.
path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/repos/{repo_id}/set-password/
/api/v2.1/repos/{repo_id}/set-password/

Change/Init repo password.

Change/Init repo password.

Permission checking:

  1. repo owner
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/repos/{repo_id}/set-password/
/api/v2.1/repos/{repo_id}/set-password/

api_v2.1_repos_tags_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/tags/
/api/v2.1/repos/{repo_id}/tags/

api_v2.1_repos_tags_create

path Parameters
repo_id
required
string

Responses

201

Created

post /api/v2.1/repos/{repo_id}/tags/
/api/v2.1/repos/{repo_id}/tags/

api_v2.1_repos_tags_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/repos/{repo_id}/tags/
/api/v2.1/repos/{repo_id}/tags/

api_v2.1_repos_tags_delete

path Parameters
repo_id
required
string
name
required
string

Responses

204

No Content

delete /api/v2.1/repos/{repo_id}/tags/{name}/
/api/v2.1/repos/{repo_id}/tags/{name}/

Return deleted files/dirs of a repo/folder

Return deleted files/dirs of a repo/folder

Permission checking:

  1. all authenticated user can perform this action.
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/trash/
/api/v2.1/repos/{repo_id}/trash/

Clean library's trash.

Clean library's trash.

Permission checking:

  1. only repo owner can perform this action.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/repos/{repo_id}/trash/
/api/v2.1/repos/{repo_id}/trash/

Get file server token for download-dir and download-multi.

Get file server token for download-dir and download-multi.

Permission checking:

  1. user with 'r' or 'rw' permission;
path Parameters
repo_id
required
string

Responses

200

OK

get /api/v2.1/repos/{repo_id}/zip-task/
/api/v2.1/repos/{repo_id}/zip-task/

api_v2.1_revision-tags_tag-names_list

Responses

200

OK

get /api/v2.1/revision-tags/tag-names/
/api/v2.1/revision-tags/tag-names/

api_v2.1_revision-tags_tagged-items_create

Responses

201

Created

post /api/v2.1/revision-tags/tagged-items/
/api/v2.1/revision-tags/tagged-items/

api_v2.1_revision-tags_tagged-items_update

Responses

200

OK

put /api/v2.1/revision-tags/tagged-items/
/api/v2.1/revision-tags/tagged-items/

api_v2.1_revision-tags_tagged-items_delete

Responses

204

No Content

delete /api/v2.1/revision-tags/tagged-items/
/api/v2.1/revision-tags/tagged-items/

Search group.

Search group.

Permission checking:

  1. default(NOT guest) user;

Responses

200

OK

get /api/v2.1/search-group/
/api/v2.1/search-group/

List groups that user can share a library to.

List groups that user can share a library to.

Responses

200

OK

get /api/v2.1/shareable-groups/
/api/v2.1/shareable-groups/

List all shared out folders.

List all shared out folders.

Permission checking:

  1. all authenticated user can perform this action.

Responses

200

OK

get /api/v2.1/shared-folders/
/api/v2.1/shared-folders/

List all shared out repos.

List all shared out repos.

Permission checking:

  1. all authenticated user can perform this action.

Responses

200

OK

get /api/v2.1/shared-repos/
/api/v2.1/shared-repos/

Update permission of a shared repo.

Update permission of a shared repo.

Permission checking:

  1. Only repo owner can update.
path Parameters
repo_id
required
string

Responses

200

OK

put /api/v2.1/shared-repos/{repo_id}/
/api/v2.1/shared-repos/{repo_id}/

Unshare a repo.

Unshare a repo.

Permission checking:

  1. Only repo owner can unshare a library.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api/v2.1/shared-repos/{repo_id}/
/api/v2.1/shared-repos/{repo_id}/

api_v2.1_user-avatar_create

Responses

201

Created

post /api/v2.1/user-avatar/
/api/v2.1/user-avatar/

currently only used for add personal wiki module

currently only used for add personal wiki module

Permission checking:

  1. login user.
  2. user can add repo

Responses

201

Created

post /api/v2.1/user-enabled-modules/
/api/v2.1/user-enabled-modules/

currently only used for delete personal wiki module

currently only used for delete personal wiki module

Permission checking:

  1. login user.
  2. user can add repo

Responses

204

No Content

delete /api/v2.1/user-enabled-modules/
/api/v2.1/user-enabled-modules/

Query/update user info of myself.

Query/update user info of myself.

Responses

200

OK

get /api/v2.1/user/
/api/v2.1/user/

Query/update user info of myself.

Query/update user info of myself.

Responses

200

OK

put /api/v2.1/user/
/api/v2.1/user/

List all wikis.

List all wikis.

Responses

200

OK

get /api/v2.1/wikis/
/api/v2.1/wikis/

Rename a Wiki

Rename a Wiki

path Parameters
slug
required
string

Responses

201

Created

post /api/v2.1/wikis/{slug}/
/api/v2.1/wikis/{slug}/

Edit a wiki permission

Edit a wiki permission

path Parameters
slug
required
string

Responses

200

OK

put /api/v2.1/wikis/{slug}/
/api/v2.1/wikis/{slug}/

Delete a wiki.

Delete a wiki.

path Parameters
slug
required
string

Responses

204

No Content

delete /api/v2.1/wikis/{slug}/
/api/v2.1/wikis/{slug}/

Get content of a wiki

Get content of a wiki

path Parameters
slug
required
string

Responses

200

OK

get /api/v2.1/wikis/{slug}/content/
/api/v2.1/wikis/{slug}/content/

List all dir files in a wiki.

List all dir files in a wiki.

path Parameters
slug
required
string

Responses

200

OK

get /api/v2.1/wikis/{slug}/dir/
/api/v2.1/wikis/{slug}/dir/

List all pages in a wiki.

List all pages in a wiki.

path Parameters
slug
required
string

Responses

200

OK

get /api/v2.1/wikis/{slug}/pages/
/api/v2.1/wikis/{slug}/pages/

Add a page in a wiki

Add a page in a wiki

path Parameters
slug
required
string

Responses

201

Created

post /api/v2.1/wikis/{slug}/pages/
/api/v2.1/wikis/{slug}/pages/

Get content of a wiki

Get content of a wiki

path Parameters
page_name
required
string
slug
required
string

Responses

200

OK

get /api/v2.1/wikis/{slug}/pages/{page_name}/
/api/v2.1/wikis/{slug}/pages/{page_name}/

Delete a page in a wiki

Delete a page in a wiki

path Parameters
page_name
required
string
slug
required
string

Responses

204

No Content

delete /api/v2.1/wikis/{slug}/pages/{page_name}/
/api/v2.1/wikis/{slug}/pages/{page_name}/

api2

Show account info.

Show account info.

Responses

200

OK

get /api2/account/info/
/api2/account/info/

List all accounts.

List all accounts. Administrator permission is required.

Responses

200

OK

get /api2/accounts/
/api2/accounts/

Query/Add/Delete a specific account.

Query/Add/Delete a specific account. Administator permission is required.

path Parameters
email
required
string

Responses

200

OK

get /api2/accounts/{email}/
/api2/accounts/{email}/

Query/Add/Delete a specific account.

Query/Add/Delete a specific account. Administator permission is required.

path Parameters
email
required
string

Responses

201

Created

post /api2/accounts/{email}/
/api2/accounts/{email}/

Query/Add/Delete a specific account.

Query/Add/Delete a specific account. Administator permission is required.

path Parameters
email
required
string

Responses

200

OK

put /api2/accounts/{email}/
/api2/accounts/{email}/

Query/Add/Delete a specific account.

Query/Add/Delete a specific account. Administator permission is required.

path Parameters
email
required
string

Responses

204

No Content

delete /api2/accounts/{email}/
/api2/accounts/{email}/

Returns auth token if username and password are valid.

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/

Responses

201

Created

post /api2/auth-token/
/api2/auth-token/

Returns a simple `pong` message when client provided an auth token.

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/

Responses

200

OK

get /api2/auth/ping/
/api2/auth/ping/

api2_avatars_group_resized_read

path Parameters
group_id
required
string
size
required
string

Responses

200

OK

get /api2/avatars/group/{group_id}/resized/{size}/
/api2/avatars/group/{group_id}/resized/{size}/

api2_avatars_user_resized_read

path Parameters
user
required
string
size
required
string

Responses

200

OK

get /api2/avatars/user/{user}/resized/{size}/
/api2/avatars/user/{user}/resized/{size}/

List repos that others/groups share to user.

List repos that others/groups share to user.

Responses

200

OK

get /api2/beshared-repos/
/api2/beshared-repos/

api2_beshared-repos_delete

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/beshared-repos/{repo_id}/
/api2/beshared-repos/{repo_id}/

Generate a token which can be used later to login directly.

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.

Responses

201

Created

post /api2/client-login/
/api2/client-login/

List dirents in dir download shared link

List dirents in dir download shared link

path Parameters
token
required
string

Responses

200

OK

get /api2/d/{token}/dir/
/api2/d/{token}/dir/

Get user's default library.

Get user's default library.

Responses

200

OK

get /api2/default-repo/
/api2/default-repo/

Get user's default library.

Get user's default library.

Responses

201

Created

post /api2/default-repo/
/api2/default-repo/

api2_device-wiped_create

Responses

201

Created

post /api2/device-wiped/
/api2/device-wiped/

List user's devices.

List user's devices.

Permission checking:

  1. All authenticated users.

Responses

200

OK

get /api2/devices/
/api2/devices/

api2_devices_delete

Responses

204

No Content

delete /api2/devices/
/api2/devices/

api2_events_list

Responses

200

OK

get /api2/events/
/api2/events/

api2_f_read

path Parameters
token
required
string

Responses

200

OK

get /api2/f/{token}/
/api2/f/{token}/

api2_f_detail_list

path Parameters
token
required
string

Responses

200

OK

get /api2/f/{token}/detail/
/api2/f/{token}/detail/

api2_groups_list

Responses

200

OK

get /api2/groups/
/api2/groups/

api2_groups_read

path Parameters
group_id
required
string

Responses

200

OK

get /api2/groups/{group_id}/
/api2/groups/{group_id}/

api2_groups_create

path Parameters
group_id
required
string

Responses

201

Created

post /api2/groups/{group_id}/
/api2/groups/{group_id}/

Add a new group.

Add a new group.

path Parameters
group_id
required
string

Responses

200

OK

put /api2/groups/{group_id}/
/api2/groups/{group_id}/

api2_groups_delete

path Parameters
group_id
required
string

Responses

204

No Content

delete /api2/groups/{group_id}/
/api2/groups/{group_id}/

api2_groups_discussions_list

path Parameters
group_id
required
string

Responses

200

OK

get /api2/groups/{group_id}/discussions/
/api2/groups/{group_id}/discussions/

api2_groups_discussions_create

path Parameters
group_id
required
string

Responses

201

Created

post /api2/groups/{group_id}/discussions/
/api2/groups/{group_id}/discussions/

api2_groups_discussions_delete

path Parameters
discuss_id
required
string
group_id
required
string

Responses

204

No Content

delete /api2/groups/{group_id}/discussions/{discuss_id}/
/api2/groups/{group_id}/discussions/{discuss_id}/

Add group members.

Add group members.

path Parameters
group_id
required
string

Responses

200

OK

put /api2/groups/{group_id}/members/
/api2/groups/{group_id}/members/

Delete group members.

Delete group members.

path Parameters
group_id
required
string

Responses

204

No Content

delete /api2/groups/{group_id}/members/
/api2/groups/{group_id}/members/

api2_groups_repos_list

path Parameters
group_id
required
string

Responses

200

OK

get /api2/groups/{group_id}/repos/
/api2/groups/{group_id}/repos/

api2_groups_repos_create

path Parameters
group_id
required
string

Responses

201

Created

post /api2/groups/{group_id}/repos/
/api2/groups/{group_id}/repos/

api2_groups_repos_delete

path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api2/groups/{group_id}/repos/{repo_id}/
/api2/groups/{group_id}/repos/{repo_id}/

Removes the api token of a device that has already logged in. If the device

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 .

Responses

201

Created

post /api2/logout-device/
/api2/logout-device/

api2_organization_create

Responses

201

Created

post /api2/organization/
/api2/organization/

Returns a simple `pong` message when client calls `api2/ping/`.

Returns a simple pong message when client calls api2/ping/. For example: curl http://127.0.0.1:8000/api2/ping/

Responses

200

OK

get /api2/ping/
/api2/ping/

Reg device for iOS push notification.

Reg device for iOS push notification.

Responses

201

Created

post /api2/regdevice/
/api2/regdevice/

api2_repo-tokens_list

Responses

200

OK

get /api2/repo-tokens/
/api2/repo-tokens/

api2_repo_history_changes_read

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repo_history_changes/{repo_id}/
/api2/repo_history_changes/{repo_id}/

api2_repos_list

Responses

200

OK

get /api2/repos/
/api2/repos/

api2_repos_public_list

Responses

200

OK

get /api2/repos/public/
/api2/repos/public/

api2_repos_public_create

Responses

201

Created

post /api2/repos/public/
/api2/repos/public/

api2_repos_read

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/
/api2/repos/{repo_id}/

api2_repos_create

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/
/api2/repos/{repo_id}/

api2_repos_delete

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/
/api2/repos/{repo_id}/

Support uniform interface for directory operations, including

Support uniform interface for directory operations, including create/delete/rename/list, etc.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/dir/
/api2/repos/{repo_id}/dir/

Support uniform interface for directory operations, including

Support uniform interface for directory operations, including create/delete/rename/list, etc.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/dir/
/api2/repos/{repo_id}/dir/

Support uniform interface for directory operations, including

Support uniform interface for directory operations, including create/delete/rename/list, etc.

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/dir/
/api2/repos/{repo_id}/dir/

api2_repos_dir_revert_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/dir/revert/
/api2/repos/{repo_id}/dir/revert/

List shared items(shared to users/groups) for a folder/library.

List shared items(shared to users/groups) for a folder/library.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/dir/shared_items/
/api2/repos/{repo_id}/dir/shared_items/

Update shared item permission.

Update shared item permission.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/dir/shared_items/
/api2/repos/{repo_id}/dir/shared_items/

Support uniform interface(list, share, unshare, modify) for sharing

Support uniform interface(list, share, unshare, modify) for sharing library/folder to users/groups.

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/dir/shared_items/
/api2/repos/{repo_id}/dir/shared_items/

Support uniform interface(list, share, unshare, modify) for sharing

Support uniform interface(list, share, unshare, modify) for sharing library/folder to users/groups.

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/dir/shared_items/
/api2/repos/{repo_id}/dir/shared_items/

Create sub-repo for folder

Create sub-repo for folder

Permission checking:

  1. user with r or rw permission.
  2. password correct for encrypted repo.
path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/dir/sub_repo/
/api2/repos/{repo_id}/dir/sub_repo/

api2_repos_download-info_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/download-info/
/api2/repos/{repo_id}/download-info/

Support uniform interface for file related operations,

Support uniform interface for file related operations, including create/delete/rename/view, etc.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/
/api2/repos/{repo_id}/file/

Support uniform interface for file related operations,

Support uniform interface for file related operations, including create/delete/rename/view, etc.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/file/
/api2/repos/{repo_id}/file/

Support uniform interface for file related operations,

Support uniform interface for file related operations, including create/delete/rename/view, etc.

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/file/
/api2/repos/{repo_id}/file/

Support uniform interface for file related operations,

Support uniform interface for file related operations, including create/delete/rename/view, etc.

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/file/
/api2/repos/{repo_id}/file/

List all comments of a file.

List all comments of a file.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/comments/
/api2/repos/{repo_id}/file/comments/

Post a comments of a file.

Post a comments of a file.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/file/comments/
/api2/repos/{repo_id}/file/comments/

Count all comments of all file under certain parent dir.

Count all comments of all file under certain parent dir.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/comments/counts/
/api2/repos/{repo_id}/file/comments/counts/

Get a comment.

Get a comment.

path Parameters
repo_id
required
string
id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/comments/{id}/
/api2/repos/{repo_id}/file/comments/{id}/

Delete a comment, only comment author or repo owner can perform

Delete a comment, only comment author or repo owner can perform this op.

path Parameters
repo_id
required
string
id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/file/comments/{id}/
/api2/repos/{repo_id}/file/comments/{id}/

api2_repos_file_detail_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/detail/
/api2/repos/{repo_id}/file/detail/

Get file history.

Get file history.

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/history/
/api2/repos/{repo_id}/file/history/

api2_repos_file_revert_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/file/revert/
/api2/repos/{repo_id}/file/revert/

api2_repos_file_revision_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/file/revision/
/api2/repos/{repo_id}/file/revision/

Copy files.

Copy files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/fileops/copy/
/api2/repos/{repo_id}/fileops/copy/

Delete files.

Delete files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/fileops/delete/
/api2/repos/{repo_id}/fileops/delete/

Move files.

Move files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/fileops/move/
/api2/repos/{repo_id}/fileops/move/

List repo group folder perms (by folder_path).

List repo group folder perms (by folder_path).

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/group-folder-perm/
/api2/repos/{repo_id}/group-folder-perm/

Add repo group folder perm.

Add repo group folder perm.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/group-folder-perm/
/api2/repos/{repo_id}/group-folder-perm/

Modify repo group folder perm.

Modify repo group folder perm.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/group-folder-perm/
/api2/repos/{repo_id}/group-folder-perm/

Remove repo group folder perm.

Remove repo group folder perm.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/group-folder-perm/
/api2/repos/{repo_id}/group-folder-perm/

api2_repos_history-limit_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/history-limit/
/api2/repos/{repo_id}/history-limit/

api2_repos_history-limit_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/history-limit/
/api2/repos/{repo_id}/history-limit/

api2_repos_history_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/history/
/api2/repos/{repo_id}/history/

Get action url and access token when view file through Office Web App

Get action url and access token when view file through Office Web App

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/owa-file/
/api2/repos/{repo_id}/owa-file/

api2_repos_owner_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/owner/
/api2/repos/{repo_id}/owner/

Currently only for transfer repo.

Currently only for transfer repo.

Permission checking:

  1. only repo owner can transfer repo.
path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/owner/
/api2/repos/{repo_id}/owner/

api2_repos_thumbnail_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/thumbnail/
/api2/repos/{repo_id}/thumbnail/

List repo user folder perms (by folder_path).

List repo user folder perms (by folder_path).

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

200

OK

get /api2/repos/{repo_id}/user-folder-perm/
/api2/repos/{repo_id}/user-folder-perm/

Add repo user folder perm.

Add repo user folder perm.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

201

Created

post /api2/repos/{repo_id}/user-folder-perm/
/api2/repos/{repo_id}/user-folder-perm/

Modify repo user folder perm.

Modify repo user folder perm.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

200

OK

put /api2/repos/{repo_id}/user-folder-perm/
/api2/repos/{repo_id}/user-folder-perm/

Remove repo user folder perms.

Remove repo user folder perms.

Permission checking:

  1. ( repo owner | admin ) & pro edition & enable folder perm.
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/repos/{repo_id}/user-folder-perm/
/api2/repos/{repo_id}/user-folder-perm/

Search user from contacts/all users

Search user from contacts/all users

Responses

200

OK

get /api2/search-user/
/api2/search-user/

Search all the repos

Search all the repos

Responses

200

OK

get /api2/search/
/api2/search/

Returns the server info (version, supported features).

Returns the server info (version, supported features).

Responses

200

OK

get /api2/server-info/
/api2/server-info/

List repos that a user share to others/groups/public.

List repos that a user share to others/groups/public.

Responses

200

OK

get /api2/shared-repos/
/api2/shared-repos/

Share a repo to users/groups/public.

Share a repo to users/groups/public.

path Parameters
repo_id
required
string

Responses

200

OK

put /api2/shared-repos/{repo_id}/
/api2/shared-repos/{repo_id}/

Unshare a library.

Unshare a library. Repo owner and system admin can perform this operation.

path Parameters
repo_id
required
string

Responses

204

No Content

delete /api2/shared-repos/{repo_id}/
/api2/shared-repos/{repo_id}/

Support uniform interface for starred file operation,

Support uniform interface for starred file operation, including add/delete/list starred files.

Responses

200

OK

get /api2/starredfiles/
/api2/starredfiles/

Support uniform interface for starred file operation,

Support uniform interface for starred file operation, including add/delete/list starred files.

Responses

201

Created

post /api2/starredfiles/
/api2/starredfiles/

Support uniform interface for starred file operation,

Support uniform interface for starred file operation, including add/delete/list starred files.

Responses

204

No Content

delete /api2/starredfiles/
/api2/starredfiles/

api2_two-factor-auth_delete

path Parameters
email
required
string

Responses

204

No Content

delete /api2/two-factor-auth/{email}/
/api2/two-factor-auth/{email}/

api2_unseen_messages_list

Responses

200

OK

get /api2/unseen_messages/
/api2/unseen_messages/

api2_wopi_files_read

path Parameters
file_id
required
string

Responses

200

OK

get /api2/wopi/files/{file_id}
/api2/wopi/files/{file_id}

api2_wopi_files_create

path Parameters
file_id
required
string

Responses

201

Created

post /api2/wopi/files/{file_id}
/api2/wopi/files/{file_id}

api2_wopi_files_contents_list

path Parameters
file_id
required
string

Responses

200

OK

get /api2/wopi/files/{file_id}/contents
/api2/wopi/files/{file_id}/contents

api2_wopi_files_contents_create

path Parameters
file_id
required
string

Responses

201

Created

post /api2/wopi/files/{file_id}/contents
/api2/wopi/files/{file_id}/contents

api3

---


YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/account/info/
/api3/account/info/

Admin - List accounts

Admin - List accounts

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/accounts/
/api3/accounts/

Admin - Get Account Info

Admin - Get Account Info

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
email
required
string

Responses

200

OK

get /api3/accounts/{email}/
/api3/accounts/{email}/

Admin - Migrate Account

Admin - Migrate Account

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
email
required
string

Responses

201

Created

post /api3/accounts/{email}/
/api3/accounts/{email}/

Admin - Create/Update Account

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.


YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR
- code: 520
  message: OPERATION_FAILED

consumes:

- application/json

produces:

- application/json
path Parameters
email
required
string

Responses

200

OK

put /api3/accounts/{email}/
/api3/accounts/{email}/

Admin - Delete Account

Admin - Delete Account

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
email
required
string

Responses

204

No Content

delete /api3/accounts/{email}/
/api3/accounts/{email}/

Activate user via email with activation key

Activate user via email with activation key

YAML

type: activation_key: required: true type: string

parameters:

  • name: Authorization required: true type: string paramType: header
  • name: activation_key description: activation key required: true type: string paramType: path

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
activation_key
required
string

Responses

200

OK

get /api3/active/{activation_key}
/api3/active/{activation_key}

Get info of common user's default library.

Get info of common user's default library.

Permission checking:

  1. only admin can perform this action.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/default-library/
/api3/admin/default-library/

Create a default library for a common user.

Create a default library for a common user.

Permission checking:

  1. only admin can perform this action.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/default-library/
/api3/admin/default-library/

Get Device Errors

Get Device Errors

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/device-errors/
/api3/admin/device-errors/

Clean Device Errors

Clean Device Errors

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/admin/device-errors/
/api3/admin/device-errors/

Get Devices

Get Devices

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/devices/
/api3/admin/devices/

Unlink User Device

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/admin/devices/
/api3/admin/devices/

Change favicon of the page

Change favicon of the page

YAML

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: favicon required: true type: file paramType: formData description: new favicon file

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/favicon/
/api3/admin/favicon/

Reset favicon of the page

Reset favicon of the page

YAML

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

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/favicon/reset/
/api3/admin/favicon/reset/

List all groups / search group by name

List all groups / search group by name

Permission checking:

  1. Admin user;

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/groups/
/api3/admin/groups/

Create a group

Create a group

Permission checking:

  1. Admin user;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/groups/
/api3/admin/groups/

Export groups to excel

Export groups to excel

Permission checking:

  1. Admin user;

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/groups/export/
/api3/admin/groups/export/

Admin transfer a group

Admin transfer a group

Permission checking:

  1. Admin user;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

put /api3/admin/groups/{group_id}/
/api3/admin/groups/{group_id}/

Dismiss a specific group

Dismiss a specific group


YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

204

No Content

delete /api3/admin/groups/{group_id}/
/api3/admin/groups/{group_id}/

List all group repos

List all group repos

Permission checking:

  1. only admin can perform this action.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/admin/groups/{group_id}/libraries/
/api3/admin/groups/{group_id}/libraries/

Unshare repo from group

Unshare repo from group

Permission checking:

  1. only admin can perform this action.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api3/admin/groups/{group_id}/libraries/{repo_id}/
/api3/admin/groups/{group_id}/libraries/{repo_id}/

List all group members

List all group members

Permission checking:

  1. only admin can perform this action.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/admin/groups/{group_id}/members/
/api3/admin/groups/{group_id}/members/

Bulk add group members.

Bulk add group members.

Permission checking:

  1. only admin can perform this action.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

201

Created

post /api3/admin/groups/{group_id}/members/
/api3/admin/groups/{group_id}/members/

update role of a group member

update role of a group member

Permission checking:

  1. only admin can perform this action.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
email
required
string

Responses

200

OK

put /api3/admin/groups/{group_id}/members/{email}/
/api3/admin/groups/{group_id}/members/{email}/

Delete an user from group

Delete an user from group

Permission checking:

  1. only admin can perform this action.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
email
required
string

Responses

204

No Content

delete /api3/admin/groups/{group_id}/members/{email}/
/api3/admin/groups/{group_id}/members/{email}/

Get all tenants

Get all tenants

Responses

200

OK

get /api3/admin/tenants/
/api3/admin/tenants/

Create a new tenant

Create a new tenant

Responses

201

Created

post /api3/admin/tenants/
/api3/admin/tenants/

Get tenant details

Get tenant details

path Parameters
inst_id
required
string

Responses

200

OK

get /api3/admin/tenants/{inst_id}/
/api3/admin/tenants/{inst_id}/

Update tenant quota

Update tenant quota

path Parameters
inst_id
required
string

Responses

200

OK

put /api3/admin/tenants/{inst_id}/
/api3/admin/tenants/{inst_id}/

Delete an tenant

Delete an tenant

path Parameters
inst_id
required
string

Responses

204

No Content

delete /api3/admin/tenants/{inst_id}/
/api3/admin/tenants/{inst_id}/

Promote or revoke tenant admin

Promote or revoke tenant admin

path Parameters
user_email
required
string
inst_id
required
string

Responses

201

Created

post /api3/admin/tenants/{inst_id}/admins/{user_email}/
/api3/admin/tenants/{inst_id}/admins/{user_email}/

Add users to tenant

Add users to tenant

path Parameters
inst_id
required
string

Responses

201

Created

post /api3/admin/tenants/{inst_id}/users/
/api3/admin/tenants/{inst_id}/users/

Remove users from tenant

Remove users from tenant

path Parameters
user_email
required
string
inst_id
required
string

Responses

204

No Content

delete /api3/admin/tenants/{inst_id}/users/{user_email}/
/api3/admin/tenants/{inst_id}/users/{user_email}/

List 'all' libraries (by name/owner/page)

List 'all' libraries (by name/owner/page)

Permission checking:

  1. only admin can perform this action.

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/libraries/
/api3/admin/libraries/

Admin create library

Admin create library

Permission checking:

  1. only admin can perform this action.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/libraries/
/api3/admin/libraries/

transfer a library

transfer a library

Permission checking:

  1. only admin can perform this action.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/admin/libraries/{repo_id}/
/api3/admin/libraries/{repo_id}/

delete a library

delete a library

Permission checking:

  1. only admin can perform this action.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/admin/libraries/{repo_id}/
/api3/admin/libraries/{repo_id}/

get info of a single file/folder in a library

get info of a single file/folder in a library

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/admin/libraries/{repo_id}/dirent/
/api3/admin/libraries/{repo_id}/dirent/

delete a single file/folder in a library

delete a single file/folder in a library

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/admin/libraries/{repo_id}/dirent/
/api3/admin/libraries/{repo_id}/dirent/

get all file/folder in a library

get all file/folder in a library

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/admin/libraries/{repo_id}/dirents/
/api3/admin/libraries/{repo_id}/dirents/

create file/folder in a library

create file/folder in a library

YAML

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: formData

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/admin/libraries/{repo_id}/dirents/
/api3/admin/libraries/{repo_id}/dirents/

Check Repo password

Check Repo password

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/admin/libraries/{repo_id}/password/
/api3/admin/libraries/{repo_id}/password/

api3_admin_license_create

Responses

201

Created

post /api3/admin/license/
/api3/admin/license/

Change logo of the page

Change logo of the page

YAML

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: logo required: true type: file paramType: formData description: new logo file

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/logo/
/api3/admin/logo/

Set logo to the default logo

YAML

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

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/logo/reset/
/api3/admin/logo/reset/

Get all public share links

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/public-shares/
/api3/admin/public-shares/

List user/group shares

List user/group shares

Permission checking:

  1. admin user.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string path: required: false type: string share_type: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: query
- name: path
  description: Path, default is "/"
  required: true
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: true
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/shares/
/api3/admin/shares/

Admin share a library to user/group.

Admin share a library to user/group.

Permission checking:

  1. admin user.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string path: required: false type: string share_type: required: true type: string share_to: required: true type: string permission: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: query
- name: path
  description: Path, default is "/"
  required: true
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: true
  type: string
  paramType: query
- name: share_to
  description: list of email
  required: true
  type: string
  paramType: query
- name: permission
  description: r or rw
  required: true
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/shares/
/api3/admin/shares/

Update user/group share permission.

Update user/group share permission.

Permission checking:

  1. admin user.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string path: required: false type: string share_type: required: true type: string share_to: required: true type: string permission: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: query
- name: path
  description: Path, default is "/"
  required: true
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: true
  type: string
  paramType: query
- name: share_to
  description: list of email
  required: true
  type: string
  paramType: query
- name: permission
  description: r or rw
  required: true
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

put /api3/admin/shares/
/api3/admin/shares/

Delete user/group share permission.

Delete user/group share permission.

Permission checking:

  1. admin user.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string path: required: false type: string share_type: required: true type: string share_to: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: query
- name: path
  description: Path, default is "/"
  required: true
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: true
  type: string
  paramType: query
- name: share_to
  description: list of email
  required: true
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/admin/shares/
/api3/admin/shares/

Show system info.

Show system info.

Responses

200

OK

get /api3/admin/sysinfo/
/api3/admin/sysinfo/

api3_admin_sysnotifications_list

Responses

200

OK

get /api3/admin/sysnotifications/
/api3/admin/sysnotifications/

Add new system notification.

Add new system notification.

YAML

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: formData

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/sysnotifications/
/api3/admin/sysnotifications/

Update notification details

Update notification details

YAML

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: formData

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
notification_id
required
string

Responses

200

OK

put /api3/admin/sysnotifications/{notification_id}/
/api3/admin/sysnotifications/{notification_id}/

Remove a notification

Remove a notification

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
notification_id
required
string

Responses

204

No Content

delete /api3/admin/sysnotifications/{notification_id}/
/api3/admin/sysnotifications/{notification_id}/

Get list system libraries

Get list system libraries

YAML

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

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/admin/system-libraries/
/api3/admin/system-libraries/

List deleted repos (by owner)

List deleted repos (by owner)

YAML

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: owner description: email of the owner required: false type: string paramType: query
  • name: page description: default to page 1 required: false type: string paramType: query
  • name: per_page description: items per page, default to 100 required: false type: string paramType: query

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

200

OK

get /api3/admin/trash_libraries/
/api3/admin/trash_libraries/

restore a deleted library

restore a deleted library

Permission checking:

  1. only admin can perform this action.

YAML

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: repo_id description: id of the repo for restoring required: true type: string paramType: path

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/admin/trash_libraries/{repo_id}/
/api3/admin/trash_libraries/{repo_id}/

permanently delete a deleted library

permanently delete a deleted library

Permission checking:

  1. only admin can perform this action.

YAML

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: repo_id description: id of the repo for permanent delete required: true type: string paramType: path

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/admin/trash_libraries/{repo_id}/
/api3/admin/trash_libraries/{repo_id}/

Remove group from groupadmin page. Only system admin can perform this

Remove group from groupadmin page. Only system admin can perform this

operation.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

204

No Content

delete /api3/admin/user-info/groups/{group_id}/
/api3/admin/user-info/groups/{group_id}/

Transfer a repo to others.

Transfer a repo to others.

YAML

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: formData

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/admin/user-info/lib/transfer/
/api3/admin/user-info/lib/transfer/

List all users from database for system admin.

List all users from database for system admin.

YAML

type: Authorization: required: true type: string page: required: true type: string per_page: required: true type: string scope: required: false type: string

parameters:

  • name: Authorization required: true type: string paramType: header
  • name: filer description: free or paid required: false type: string paramType: query
  • name: page description: default 1 required: false type: string paramType: query
  • name: per_page description: default 25 required: false type: string paramType: query

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

200

OK

get /api3/admin/users/
/api3/admin/users/

List admins for system admins

List admins for system admins

YAML

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

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

200

OK

get /api3/admin/users/admins/
/api3/admin/users/admins/

Revoke admin permission of an admin

Revoke admin permission of an admin

YAML

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: user_email required: true type: string paramType: path description: email of the admin who going to be revoked

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
user_email
required
string

Responses

201

Created

post /api3/admin/users/admins/{user_email}/
/api3/admin/users/admins/{user_email}/

Set user quota, set user tenant, delete users, in batch.

Set user quota, set user tenant, delete users, in batch.

YAML

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: operation description: set-quota, delete-user or set-tenant required: true type: string enum: [set-quota,delete-user,set-tenant] paramType: formData
  • name: quota_total description: quota required: true type: string paramType: formData
  • name: emails description: multiple user emails required: true type: string paramType: formData

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/users/batch/
/api3/admin/users/batch/

Export all users from database to excel

Export all users from database to excel

YAML

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

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

200

OK

get /api3/admin/users/export/
/api3/admin/users/export/

Batch add users. Import users from CSV file.

Batch add users. Import users from CSV file.

YAML

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: file required: true type: file paramType: formData description: csv file

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/admin/users/import/
/api3/admin/users/import/

Search user

Search user

YAML

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: q description: search query required: false type: string paramType: query
  • name: page description: result page. Default to 1 required: false type: string paramType: query
  • name: per_page description: result per page. Default to 25 required: false type: string paramType: query

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

200

OK

get /api3/admin/users/search/
/api3/admin/users/search/

Get user profile

Get user profile

YAML

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: user_email description: user email required: true type: string paramType: path

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
user_email
required
string

Responses

200

OK

get /api3/admin/users/{user_email}/
/api3/admin/users/{user_email}/

Reset password for user.

Reset password for user.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
user_email
required
string

Responses

201

Created

post /api3/admin/users/{user_email}/
/api3/admin/users/{user_email}/

Remove a user from the system

Remove a user from the system

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
user_email
required
string

Responses

204

No Content

delete /api3/admin/users/{user_email}/
/api3/admin/users/{user_email}/

Change role of a user

Change role of a user

YAML

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: email
  • name: Authorization required: true type: string paramType: path
  • name: r required: false type: string paramType: formData description: default or guest. Default to default

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
user_email
required
string

Responses

201

Created

post /api3/admin/users/{user_email}/toggle-roles/
/api3/admin/users/{user_email}/toggle-roles/

Active or deactive user

Active or deactive user

YAML

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 required: true type: string paramType: path
  • name: s required: false type: string paramType: formData description: 0 (inactive) or 1 (active). Default to 0

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json
path Parameters
user_email
required
string

Responses

201

Created

post /api3/admin/users/{user_email}/toggle-status/
/api3/admin/users/{user_email}/toggle-status/

Get Authorization Status

Get Authorization Status

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/auth-status
/api3/auth-status

---


YAML

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 0

responseMessages:

- code: 400
  message: BAD REQUEST
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/auth-token
/api3/auth-token

Get Group Avatar

Get Group Avatar

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
size
required
string

Responses

200

OK

get /api3/avatars/group/{group_id}/resized/{size}/
/api3/avatars/group/{group_id}/resized/{size}/

Get User Avatar

Get User Avatar

YAML

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: path

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
user
required
string
size
required
string

Responses

200

OK

get /api3/avatars/user/{user}/resized/{size}/
/api3/avatars/user/{user}/resized/{size}/

List repos that others/groups share to user.

List repos that others/groups share to user.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/beshared-repos/
/api3/beshared-repos/

Delete Be Shared Library

Delete Be Shared Library

YAML

type: Authorization: required: true type: string repo_id: required: true type: string share_type: required: false type: string from: 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: share_type
  description: personal, group, public
  required: false
  type: string
  paramType: query
- name: from
  required: false
  type: string
  paramType: query
- name: group_id
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/beshared-repos/{repo_id}/
/api3/beshared-repos/{repo_id}/

Copy/move file/dir, and return task id.

Copy/move file/dir, and return task id.

Permission checking:

  1. move: user with 'rw' permission for current file, 'rw' permission for dst parent dir;
  2. copy: user with 'r' permission for current file, 'rw' permission for dst parent dir;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/copy-move-task/
/api3/copy-move-task/

Cancel file/dir mv/cp.

Cancel file/dir mv/cp.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/copy-move-task/
/api3/copy-move-task/

Set primary notification.

Set primary notification.

YAML

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: path

responseMessages:

- code: 400
    message: BAD_REQUEST
- code: 401
    message: UNAUTHORIZED
- code: 403
    message: FORBIDDEN
- code: 404
    message: NOT_FOUND
- code: 500
    message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/current-system-notification/
/api3/current-system-notification/

View dir via shared link.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/d/{token}/
/api3/d/{token}/

View dir via shared link.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

201

Created

post /api3/d/{token}/
/api3/d/{token}/

List dirents in dir download shared link

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/d/{token}/dir/
/api3/d/{token}/dir/

View file via shared dir link.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/d/{token}/files/
/api3/d/{token}/files/

View file via shared dir link.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

201

Created

post /api3/d/{token}/files/
/api3/d/{token}/files/

Delete Account

Delete Account

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/delete-account/
/api3/delete-account/

Get the deleted-repos of owner

Get the deleted-repos of owner

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/deleted-repos/
/api3/deleted-repos/

Restore deleted-repo

Restore deleted-repo return: return True if success, otherwise api_error


YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/deleted-repos/
/api3/deleted-repos/

List user's devices.

List user's devices.

Permission checking:

  1. All authenticated users.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/devices/
/api3/devices/

Unlink User Device

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/devices/
/api3/devices/

Get File Activities

Get File Activities This api will only return first 15 records of activities. if want get more, pass start parameter


YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/events/
/api3/events/

View file via shared link.

View file via shared link. Download share file if dl in request param. View raw share file if raw in request param.


YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/f/{token}/
/api3/f/{token}/

View file via shared link.

View file via shared link. Download share file if dl in request param. View raw share file if raw in request param.


YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

201

Created

post /api3/f/{token}/
/api3/f/{token}/

Get / refresh captcha

Get / refresh captcha

YAML

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_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/get-captcha
/api3/get-captcha

List all groups.

List all groups.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/groups/
/api3/groups/

Create a group

Create a group

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/groups/
/api3/groups/

Get info of a group.

Get info of a group.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/groups/{group_id}/
/api3/groups/{group_id}/

Rename, transfer a specific group

Rename, transfer a specific group

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

put /api3/groups/{group_id}/
/api3/groups/{group_id}/

Dismiss a specific group

Dismiss a specific group

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

204

No Content

delete /api3/groups/{group_id}/
/api3/groups/{group_id}/

List all group discussions. Only group members can perform this op.

List all group discussions. Only group members can perform this op.

YAML

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: form

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/groups/{group_id}/discussions/
/api3/groups/{group_id}/discussions/

Post a group discussion. Only group members can perform this op.

Post a group discussion. Only group members can perform this op.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

201

Created

post /api3/groups/{group_id}/discussions/
/api3/groups/{group_id}/discussions/

Remove a group discussion.

Remove a group discussion.

Only discussion creator or group owner/admin can perform this op.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
discuss_id
required
string
group_id
required
string

Responses

204

No Content

delete /api3/groups/{group_id}/discussions/{discuss_id}/
/api3/groups/{group_id}/discussions/{discuss_id}/

Get all group members.

Get all group members.

YAML

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: form

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/groups/{group_id}/members/
/api3/groups/{group_id}/members/

Add a group member.

Add a group member.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

201

Created

post /api3/groups/{group_id}/members/
/api3/groups/{group_id}/members/

Bulk add group members.

Bulk add group members.

YAML

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: form

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

201

Created

post /api3/groups/{group_id}/members/bulk/
/api3/groups/{group_id}/members/bulk/

Get info of a specific group member.

Get info of a specific group member.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
email
required
string

Responses

200

OK

get /api3/groups/{group_id}/members/{email}/
/api3/groups/{group_id}/members/{email}/

Set/unset a specific group member as admin.

Set/unset a specific group member as admin.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
email
required
string

Responses

200

OK

put /api3/groups/{group_id}/members/{email}/
/api3/groups/{group_id}/members/{email}/

User leave group or group owner/admin delete a group member.

User leave group or group owner/admin delete a group member.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string
email
required
string

Responses

204

No Content

delete /api3/groups/{group_id}/members/{email}/
/api3/groups/{group_id}/members/{email}/

Get group repos

Get group repos

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/groups/{group_id}/repos/
/api3/groups/{group_id}/repos/

Add a group repo

Add a group repo

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

201

Created

post /api3/groups/{group_id}/repos/
/api3/groups/{group_id}/repos/

Delete a group repo

Delete a group repo

YAML

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: path

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string
group_id
required
string

Responses

204

No Content

delete /api3/groups/{group_id}/repos/{repo_id}/
/api3/groups/{group_id}/repos/{repo_id}/

Search user from contacts/all users

Search user from contacts/all users

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
group_id
required
string

Responses

200

OK

get /api3/groups/{group_id}/search_user/
/api3/groups/{group_id}/search_user/

New API for list library directory

New API for list library directory

path Parameters
repo_id
required
string

Responses

200

OK

get /api3/lib/{repo_id}/dir/
/api3/lib/{repo_id}/dir/

Get configuration for the login page

Get configuration for the login page

YAML

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_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/login-config
/api3/login-config

Removes the api token of a device that has already logged in. If the device

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 .

Responses

201

Created

post /api3/logout
/api3/logout

currently only used for mark a notification seen

currently only used for mark a notification seen

Permission checking:

  1. login user.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

put /api3/notification/
/api3/notification/

Get user's notifications.

Get user's notifications.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/notifications/
/api3/notifications/

currently only used for mark all notifications seen

currently only used for mark all notifications seen

Permission checking:

  1. login user.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

put /api3/notifications/
/api3/notifications/

Clean all notifications

Clean all notifications

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/notifications/
/api3/notifications/

currently only used for get unseen notifications count

currently only used for get unseen notifications count

Permission checking:

  1. login user.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/notifications/count/
/api3/notifications/count/

Get user's notifications.

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:

  1. login user.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/notifications/top/
/api3/notifications/top/

Password Reset

Password Reset

YAML

type: email: required: true type: string

parameters:

- name: email
  required: true
  type: string
  paramType: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/password/reset/
/api3/password/reset/

Validate Password Reset Token

Validate Password Reset Token

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
uidb36
required
string
token
required
string

Responses

200

OK

get /api3/password/reset/confirm/{uidb36}-{token}/
/api3/password/reset/confirm/{uidb36}-{token}/

Confirm Password Reset

Confirm Password Reset

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
uidb36
required
string
token
required
string

Responses

201

Created

post /api3/password/reset/confirm/{uidb36}-{token}/
/api3/password/reset/confirm/{uidb36}-{token}/

Returns a simple `pong` message when client calls `api2/ping/`.

Returns a simple pong message when client calls api2/ping/. For example: curl http://127.0.0.1:8000/api3/ping/

Responses

200

OK

get /api3/ping
/api3/ping

Get User Profile

Get User Profile

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/profile/
/api3/profile/

Update User Profile

Update User Profile

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/profile/
/api3/profile/

Update User Language

Update User Language

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

put /api3/profile/
/api3/profile/

Update User Avatar

Update User Avatar

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/profile/avatar/
/api3/profile/avatar/

Delete User Avatar

Delete User Avatar

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/profile/avatar/
/api3/profile/avatar/

Get user's default library.

Get user's default library.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/profile/default-repo/
/api3/profile/default-repo/

Set user's default library.

Set user's default library.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/profile/default-repo/
/api3/profile/default-repo/

Change Password

Change Password

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
Request Body schema: application/json
old_password
required
string
new_password1
required
string
new_password2
required
string

Responses

201

Created

post /api3/profile/password/
/api3/profile/password/

Request samples

application/json
Copy
Expand all Collapse all
{
  • "old_password": "string",
  • "new_password1": "string",
  • "new_password2": "string"
}

Fetch progress of file/dir mv/cp.

Fetch progress of file/dir mv/cp.

Permission checking:

  1. user login;

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/query-copy-move-progress/
/api3/query-copy-move-progress/

Check progress when download dir/multi.

Check progress when download dir/multi.

YAML

type: token: required: true type: string

parameters:

- name: token
  description: Download token
  required: true
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/query-zip-progress/
/api3/query-zip-progress/

User register

User register

YAML

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 user email required: true type: string paramType: formData
  • name: password1 description: password required: true type: string paramType: formData
  • name: password2 description: confirm password required: true type: string paramType: formData

responseMessages:

  • code: 400 message: BAD_REQUEST
  • code: 401 message: UNAUTHORIZED
  • code: 403 message: FORBIDDEN
  • code: 404 message: NOT_FOUND
  • code: 500 message: INTERNAL_SERVER_ERROR

consumes:

  • application/json produces:
  • application/json

Responses

201

Created

post /api3/register
/api3/register

Download file in repo/file history page.

Download file in repo/file history page.

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string
obj_id
required
string

Responses

200

OK

get /api3/repo/{repo_id}/{obj_id}/download/
/api3/repo/{repo_id}/{obj_id}/download/

List Libraries

List Libraries

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/repos/
/api3/repos/

List public repos

List public repos

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/repos/public/
/api3/repos/public/

Create public repo

Create public repo

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/repos/public/
/api3/repos/public/

Get library detail

Get library detail

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/
/api3/repos/{repo_id}/

---


YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/
/api3/repos/{repo_id}/

Delete single library by id

Delete single library by id

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/
/api3/repos/{repo_id}/

Get dir info.

Get dir info.

Permission checking:

  1. user with either 'r' or 'rw' permission.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/
/api3/repos/{repo_id}/dir/

Create, rename, revert dir.

Create, rename, revert dir.

Permission checking:

  1. create: user with 'rw' permission for current dir's parent dir;
  2. rename: user with 'rw' permission for current dir;
  3. revert: user with 'rw' permission for current dir's parent dir;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/dir/
/api3/repos/{repo_id}/dir/

Delete dir.

Delete dir.

Permission checking:

  1. user with 'rw' permission.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/dir/
/api3/repos/{repo_id}/dir/

Get dir info.

Get dir info.

Permission checking:

  1. user with either 'r' or 'rw' permission.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/detail/
/api3/repos/{repo_id}/dir/detail/

Search group to share.

Search group to share.

Permission checking:

  1. default(NOT guest) user;

YAML

type: Authorization: required: true type: string repo_id: required: true type: string q: required: true type: string p: required: false type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: path
- name: q
  description: Keyword to search
  required: true
  type: string
  paramType: query
- name: p
  description: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/share_search_group/
/api3/repos/{repo_id}/dir/share_search_group/

Search user from contacts/all users to share

Search user from contacts/all users to share

YAML

type: Authorization: required: true type: string repo_id: required: true type: string q: required: true type: string p: required: false type: string include_self: 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: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query
- name: q
  description: Keyword to search
  required: true
  type: string
  paramType: query
- name: include_self
  description: 0 or 1
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/share_search_user/
/api3/repos/{repo_id}/dir/share_search_user/

List shared items(shared to users/groups) for a folder/library.

List shared items(shared to users/groups) for a folder/library.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string p: required: false type: string share_type: 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: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: false
  type: string
  paramType: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/shared_items/
/api3/repos/{repo_id}/dir/shared_items/

Update shared item permission.

Update shared item permission.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string p: required: false type: string share_type: required: false type: string permission: required: false type: string username: 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: p
  description: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: false
  type: string
  paramType: query
- name: permission
  description: r or rw
  required: false
  type: string
  paramType: form
- name: username
  description: a email string
  required: false
  type: string
  paramType: query
- name: group_id
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/dir/shared_items/
/api3/repos/{repo_id}/dir/shared_items/

Update shared item permission.

Update shared item permission.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string p: required: false type: string share_type: required: false type: string permission: required: false type: string username: 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: p
  description: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: false
  type: string
  paramType: form
- name: permission
  description: r or rw, default r
  required: false
  type: string
  paramType: form
- name: username
  description: a email string or a list contains multi emails, necessary if share_type is user
  required: false
  type: string
  paramType: form
- name: group_id
  description: an integer or a list contains multi integers, necessary if share_type is group
  required: false
  type: string
  paramType: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/dir/shared_items/
/api3/repos/{repo_id}/dir/shared_items/

Delete shared item

Delete shared item

YAML

type: Authorization: required: true type: string repo_id: required: true type: string p: required: false type: string username: required: false type: string group_id: required: false type: string share_type: 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: / means the root folder, which is equivalent to the library.
  required: false
  type: string
  paramType: query
- name: username
  description: a email string
  required: false
  type: string
  paramType: query
- name: group_id
  description: an integer
  required: false
  type: string
  paramType: query
- name: share_type
  description: user or group
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/dir/shared_items/
/api3/repos/{repo_id}/dir/shared_items/

Create sub-repo for folder

Create sub-repo for folder

Permission checking:

  1. user with r or rw permission.
  2. password correct for encrypted repo.
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dir/sub_repo/
/api3/repos/{repo_id}/dir/sub_repo/

Get dirents in a dir for file tree

Get dirents in a dir for file tree

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/dirents/
/api3/repos/{repo_id}/dirents/

Delete multi files/dirs.

Delete multi files/dirs.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/dirents/delete/
/api3/repos/{repo_id}/dirents/delete/

api3_repos_download-info_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/download-info/
/api3/repos/{repo_id}/download-info/

Get file info.

Get file info.

Permission checking:

  1. user with either 'r' or 'rw' permission.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/
/api3/repos/{repo_id}/file/

Create, rename, move, copy, revert file

Create, rename, move, copy, revert file

Permission checking:

  1. create: user with 'rw' permission for current parent dir;
  2. rename: user with 'rw' permission for current file;
  3. move : user with 'rw' permission for current file, 'rw' permission for dst parent dir;
  4. copy : user with 'r' permission for current file, 'rw' permission for dst parent dir;
  5. revert: user with 'rw' permission for current file's parent dir;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/file/
/api3/repos/{repo_id}/file/

Currently only for lock and unlock file operation.

Currently only for lock and unlock file operation.

Permission checking:

  1. user with 'rw' permission for current file;

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/file/
/api3/repos/{repo_id}/file/

Delete file.

Delete file.

Permission checking:

  1. user with 'rw' permission.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/file/
/api3/repos/{repo_id}/file/

List all comments of a file.

List all comments of a file.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/comments/
/api3/repos/{repo_id}/file/comments/

Post a comments of a file.

Post a comments of a file.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/file/comments/
/api3/repos/{repo_id}/file/comments/

Count all comments of all file under certain parent dir.

Count all comments of all file under certain parent dir.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/comments/counts/
/api3/repos/{repo_id}/file/comments/counts/

Get a comment.

Get a comment.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string
id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/comments/{id}/
/api3/repos/{repo_id}/file/comments/{id}/

Delete a comment, only comment author or repo owner can perform

Delete a comment, only comment author or repo owner can perform

this op.

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string
id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/file/comments/{id}/
/api3/repos/{repo_id}/file/comments/{id}/

Get Fie Detail

Get Fie Detail

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/detail/
/api3/repos/{repo_id}/file/detail/

Get file edit params

Get file edit params

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/edit/
/api3/repos/{repo_id}/file/edit/

Submit file edit

Submit file edit

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/file/edit/
/api3/repos/{repo_id}/file/edit/

Steps to view file:

Steps to view file:

  1. Get repo id and file path.
  2. Check user's permission.
  3. Check whether this file can be viewed online. 4.1 Get file content if file is text file. 4.2 Prepare flash if file is document. 4.3 Prepare or use pdfjs if file is pdf. 4.4 Other file return it's raw path.

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/preview/
/api3/repos/{repo_id}/file/preview/

Get file revision preview

Get file revision preview

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/revision/preview/
/api3/repos/{repo_id}/file/revision/preview/

List file revisions in file version history page.

List file revisions in file version history page.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/revisions/
/api3/repos/{repo_id}/file/revisions/

Get text diff

Get text diff

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/file/text_diff/
/api3/repos/{repo_id}/file/text_diff/

Copy files.

Copy files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/fileops/copy/
/api3/repos/{repo_id}/fileops/copy/

Delete files.

Delete files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/fileops/delete/
/api3/repos/{repo_id}/fileops/delete/

Move files.

Move files.

path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/fileops/move/
/api3/repos/{repo_id}/fileops/move/

List repo group folder perms (by folder_path).

List repo group folder perms (by folder_path).

Permission checking:

  1. repo owner & pro edition.

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/group-folder-perm/
/api3/repos/{repo_id}/group-folder-perm/

Add repo group folder perm.

Add repo group folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/group-folder-perm/
/api3/repos/{repo_id}/group-folder-perm/

Modify repo group folder perm.

Modify repo group folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/group-folder-perm/
/api3/repos/{repo_id}/group-folder-perm/

Remove repo group folder perm.

Remove repo group folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/group-folder-perm/
/api3/repos/{repo_id}/group-folder-perm/

api3_repos_history-limit_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/history-limit/
/api3/repos/{repo_id}/history-limit/

api3_repos_history-limit_update

path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/history-limit/
/api3/repos/{repo_id}/history-limit/

Return history of library

Return history of library

Permission checking:

  1. all authenticated user can perform this action.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/history/
/api3/repos/{repo_id}/history/

Get history changes

Get history changes

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/history/changes/
/api3/repos/{repo_id}/history/changes/

View repo in history.

View repo in history.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/history/snapshot/
/api3/repos/{repo_id}/history/snapshot/

Restore library's history snapshot

Restore library's history snapshot

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/history/snapshot/
/api3/repos/{repo_id}/history/snapshot/

api3_repos_owner_list

path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/owner
/api3/repos/{repo_id}/owner

Currently only for transfer repo.

Currently only for transfer repo.

Permission checking:

  1. only repo owner can transfer repo.
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/owner
/api3/repos/{repo_id}/owner

Check Repo password

Check Repo password

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/password/
/api3/repos/{repo_id}/password/

Change repo password.

Change repo password.

Permission checking:

  1. repo owner

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/password/
/api3/repos/{repo_id}/password/

Get Thumbnail Image

Get Thumbnail Image

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/thumbnail/
/api3/repos/{repo_id}/thumbnail/

Get items in repo trash

Get items in repo trash

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/trash/
/api3/repos/{repo_id}/trash/

Clean Repo Trash

Clean Repo Trash

YAML

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: form

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/trash/clean/
/api3/repos/{repo_id}/trash/clean/

Get items in directory trash.

Get items in directory trash.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/trash/dir/
/api3/repos/{repo_id}/trash/dir/

Restore directory

Restore directory

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/trash/dir/restore/
/api3/repos/{repo_id}/trash/dir/restore/

---


YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/trash/file/
/api3/repos/{repo_id}/trash/file/

Restore file

Restore file

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/trash/file/restore/
/api3/repos/{repo_id}/trash/file/restore/

List first/'more' batch of repo/dir trash.

List first/'more' batch of repo/dir trash.

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/trash/more/
/api3/repos/{repo_id}/trash/more/

List repo user folder perms (by folder_path).

List repo user folder perms (by folder_path).

Permission checking:

  1. repo owner & pro edition.

YAML

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: query

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/user-folder-perm/
/api3/repos/{repo_id}/user-folder-perm/

Add repo user folder perm.

Add repo user folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

201

Created

post /api3/repos/{repo_id}/user-folder-perm/
/api3/repos/{repo_id}/user-folder-perm/

Modify repo user folder perm.

Modify repo user folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/repos/{repo_id}/user-folder-perm/
/api3/repos/{repo_id}/user-folder-perm/

Remove repo user folder perm.

Remove repo user folder perm.

Permission checking:

  1. repo owner & pro edition & enable folder perm.

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/repos/{repo_id}/user-folder-perm/
/api3/repos/{repo_id}/user-folder-perm/

Get file server token for download-dir and download-multi.

Get file server token for download-dir and download-multi.

Permission checking:

  1. user with 'r' or 'rw' permission;

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

get /api3/repos/{repo_id}/zip-task/
/api3/repos/{repo_id}/zip-task/

Get available role list

Get available role list

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/roles/
/api3/roles/

Search group.

Search group.

Permission checking:

  1. default(NOT guest) user;

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/search-group/
/api3/search-group/

Search user from contacts/all users

Search user from contacts/all users

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/search-user/
/api3/search-user/

API for exposing system version.

API for exposing system version.

Responses

200

OK

get /api3/server-info
/api3/server-info

Get constance settings by keys.

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


YAML

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_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/settings/by-keys
/api3/settings/by-keys

Get restapi settings by keys.

Get restapi settings by keys.

The valid system setting keys are: CLOUD_MODE


YAML

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_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/settings/restapi/by-keys
/api3/settings/restapi/by-keys

List all shared out folders.

List all shared out folders.

Permission checking:

  1. all authenticated user can perform this action.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/shared-folders/
/api3/shared-folders/

List all shared out repos.

List all shared out repos.

Permission checking:

  1. all authenticated user can perform this action.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/shared-repos/
/api3/shared-repos/

Update permission of a shared repo.

Update permission of a shared repo.

Permission checking:

  1. Only repo owner can update.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string permission: required: false type: string share_type: required: false type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: path
- name: permission
  required: false
  type: string
  paramType: form
- name: share_type
  required: false
  type: string
  paramType: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

200

OK

put /api3/shared-repos/{repo_id}/
/api3/shared-repos/{repo_id}/

Unshare a repo.

Unshare a repo.

Permission checking:

  1. Only repo owner can unshare a library.

YAML

type: Authorization: required: true type: string repo_id: required: true type: string share_type: required: false type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header
- name: repo_id
  required: true
  type: string
  paramType: path
- name: share_type
  required: false
  type: string
  paramType: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
repo_id
required
string

Responses

204

No Content

delete /api3/shared-repos/{repo_id}/
/api3/shared-repos/{repo_id}/

api3_shares_list

Responses

200

OK

get /api3/shares/
/api3/shares/

Get space and traffic info

Get space and traffic info

Responses

200

OK

get /api3/space-traffic/
/api3/space-traffic/

List starred files

List starred files

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/starredfiles/
/api3/starredfiles/

Add starred file

Add starred file

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/starredfiles/
/api3/starredfiles/

Remove starred file

Remove starred file

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

204

No Content

delete /api3/starredfiles/
/api3/starredfiles/

List admin settings.

List admin settings.


YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/sys/settings/
/api3/sys/settings/

Update admin settings

Update admin settings


YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

201

Created

post /api3/sys/settings/
/api3/sys/settings/

Get shared upload link detail

YAML

type: token: required: true type: string

parameters:

- name: token
  required: true
  type: string
  paramType: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/u/d/{token}/
/api3/u/d/{token}/

Get shared upload link detail

YAML

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: form

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

201

Created

post /api3/u/d/{token}/
/api3/u/d/{token}/

Get file upload url in dir upload link.

Get file upload url in dir upload link.

Arguments:

  • request:
  • token:

YAML

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: query

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 403
  message: FORBIDDEN
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
token
required
string

Responses

200

OK

get /api3/u/d/{token}/upload/
/api3/u/d/{token}/upload/

Get a user's unencrypt repos that he/she can read-write.

Get a user's unencrypt repos that he/she can read-write.

YAML

type: Authorization: required: true type: string

parameters:

- name: Authorization
  required: true
  type: string
  paramType: header

responseMessages:

- code: 401
  message: UNAUTHORIZED
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json

Responses

200

OK

get /api3/unenc-rw-repos/
/api3/unenc-rw-repos/

Get profile detail by specific User's email

Get profile detail by specific User's email

YAML

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: path

responseMessages:

- code: 400
  message: BAD_REQUEST
- code: 401
  message: UNAUTHORIZED
- code: 404
  message: NOT_FOUND
- code: 500
  message: INTERNAL_SERVER_ERROR

consumes:

- application/json

produces:

- application/json
path Parameters
email
required
string

Responses

200

OK

get /api3/user/profile/{email}/
/api3/user/profile/{email}/