The official SecureCloud API Reference.

Basic Concepts

This API documentation provides a comprehensive guide to interacting with the SecureCloud Web API. It is structured around the OpenAPI 3.0.3 specification and includes detailed information about endpoints, parameters, request bodies, and responses.

Authentication

The API supports two primary authentication mechanisms:

Account-Token: This token is generated using a username and password and is required for most user-related actions. It is passed as a Bearer token in the HTTP Authorization header.
Repo-Token: This token is specific to a library (repo) and is used for operations within that library. It is also passed as a Bearer token in the HTTP Authorization header. However, its scope is limited to the library it was generated for.

Limits of the Repo-Token

The Repo-Token is designed for fine-grained access control within a specific library. It cannot be used for actions outside the scope of the associated library. This ensures that access is restricted to only the resources explicitly permitted by the token.

Separation of Actions

The API is designed with a clear separation of concerns between user actions and admin actions:

User Actions: These include operations like managing files, directories, and libraries, as well as sharing resources and managing personal settings.
Admin Actions: These include system-level operations such as managing user accounts, groups, libraries, organizations, share links, notifications and logs. The operations relevant for system administrators are marked with System Admin.

This separation ensures that users can only perform actions within their scope of permissions, while administrators retain control over system-wide configurations.

200OK

400publish_url missing, invalid, wrong length or already used by another wiki

403No permission to publish wikis, or not wiki owner/group admin

404Wiki not found