The SecureCloud API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

Terminology

Users

user_id: The unique user id in the form ...@auth.local. In old versions, this is the same as a user's real email. In new versions, user's real email is stored in contact_email field instead. It is unchangeable.
email: Same as user_id. The term is still used in API's returned value. The term should be avoided in other places.
username: Same as user_id, used internally.
contact_email: User's contact email, which is also a user's real email. It is changeable.

Usage

Authentication & Status Codes

For detailed information on authentication methods and HTTP status codes, please refer to our dedicated support articles on Authentication and Status Codes.

Actions: User vs. Administrator

The API clearly distinguishes between two areas:

User actions include managing files, folders, and libraries, as well as sharing resources and personal settings.

Administrator actions include system-wide operations such as managing user accounts, groups, organizations, share links, notifications, and logs. These endpoints are marked with "System Admin" in the documentation.

API Documentation Features

Our API documentation offers the following helpful features:

Interactive API testing: You can execute API calls directly in your browser without having to install additional tools. Simply enter your authentication credentials and test the endpoints live.

Code snippets: Code examples in various programming languages are automatically generated for each API endpoint, including cURL, Python, JavaScript, PHP, Ruby, and more. This allows you to copy the appropriate code directly into your project.

Detailed request/response documentation: Each endpoint shows you exactly which parameters are expected and how the response is structured – including sample data.

Server selection: You can select your desired server in the documentation if you operate your own SecureCloud instance with a custom domain.

Getting Started

To use the API, we recommend the following approach:

Open the API documentation
Start with the "Get Server Information" endpoint at /api2/server-info/ – this requires no authentication and returns information about the server version
Generate an account token via the corresponding authentication endpoint /api2/auth-token/
Explore the other endpoints according to your requirements, using the previously generated account token

Help and Support

If you have questions about using the API, you can reach us at:

☎️ +49 (0) 9181 - 27 308 -0
📧 support@securecloud.de