With SecureCloud 13.0, some endpoints of the SecureCloud Web API have changed. This page lists everything you should check in existing scripts and integrations. The complete, updated API documentation is available as usual at https://support.securecloud.de/reference.
In shortThe vast majority of endpoints continue to work unchanged. You mainly need to adjust your integration if you use file comments, share links to folders or revoking invitations via the API.
Removed endpoints and their successors
| Previously | Successor in SecureCloud 13.0 |
|---|---|
GET/POST /api2/repos/{repo_id}/file/comments/?p=... | GET/POST /api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/ |
GET/PUT/DELETE /api2/repos/{repo_id}/file/comments/{id}/ | GET/PUT/DELETE /api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/{comment_id}/ |
GET /api2/repos/{repo_id}/file/comments/counts/ | Removed without replacement. The comment list of a file returns the number of comments in the total_count field. |
GET /api2/d/{token}/dir/ (contents of a folder share link) | GET /api/v2.1/share-links/{token}/dirents/ |
File comments are no longer addressed by the file path but by the file's unique ID (file_uuid). You can obtain the file_uuid via GET /api/v2.1/smart-link/?repo_id=...&path=...&is_dir=false in the smart_link_token field. Also new are replies to comments (.../comments/{comment_id}/replies/) and the filters resolved, page and per_page.
Changed calls
- Revoking an invitation is done via
POST /api/v2.1/invitations/{token}/revoke/. The previous documentation incorrectly statedDELETE. - Transferring a library (
PUT /api2/repos/{repo_id}/owner/and, for administrators,PUT /api/v2.1/admin/libraries/{repo_id}/): Existing shares with users and groups are only kept if you sendreshare=true. - Sharing a library with all users (
POST /api2/repos/public/): The default permission is now read-write (rw). If you only want to grant read access, sendpermission=rexplicitly. - Share links (
/api/v2.1/share-links/) support an access scopeuser_scope(all_users,specific_users,specific_emails). Alternatively, the expiration date can be set viaexpiration_time(ISO 8601). In the response,permissionsis an object. - Copying and moving files: In case of name conflicts in the destination, files are renamed automatically, for example to "File (1).txt".
- Status codes:
- Deleting a locked file returns
423instead of403. - "Too many files in library" returns
447instead of442. - Creating a group, adding a group member and creating an invitation respond with
201.
- Deleting a locked file returns
- Image and avatar sizes: The
avatar_sizeparameter is no longer evaluated, and theavatar_urlfield is no longer returned for groups. - Starred items pointing to deleted items are returned with
deleted: trueinstead of being hidden. - Full-text search (
/api2/search/): Matches in folders that are shared with you invisibly are no longer returned.
New endpoints
- Replies to file comments:
/api/v2.1/repos/{repo_id}/file/{file_uuid}/comments/{comment_id}/replies/ - Recently changed files of a library via library token:
GET /api/v2.1/via-repo-token/recently-changed-files/ - Recently deleted files of a library via library token:
GET /api/v2.1/via-repo-token/recently-deleted-files/ - The repo token endpoints for creating, modifying, locking, moving, copying and deleting files and folders as well as for creating share links are now fully documented.
Corrections to the documentation
During the update, we compared the entire API documentation against the software and also fixed errors in the previous documentation. If your integration did not work as expected based on the old documentation, check these points:
- List directory contents (
GET /api2/repos/{repo_id}/dir/): The type filter is calledt, nottype. - Revert a folder (
PUT /api2/repos/{repo_id}/dir/revert/): The field is calledp, notpath. - Move or copy a file (
POST /api/v2.1/repos/{repo_id}/file/): In addition todst_dir,dst_repois required. - Get the tags of a file (
GET /api/v2.1/repos/{repo_id}/file-tags/): The parameter is calledfile_path. - Remove a device with remote wipe (
DELETE /api2/devices/): The parameter is calledwipe_device. - Create a department library: The password field is called
passwd. - Admin shares (
/api/v2.1/admin/shares/):share_typeisuserorgroup. - Wiki endpoints: The
wiki_idis the 36-character ID of the wiki library, not a number. - Snapshots: The
commit_idis a 40-character hex ID.
Help and support
If you have questions about updating your integration, you can reach us at:
- ☎️ +49 (0) 9181 - 27 308 -0
- 📧 [email protected]