Page tree

Teamwork Cloud 2021x Refresh1 Documentation

Teamwork Cloud provides a set of REST API for server management. REST APIs are the essential properties in TWCloud that allow you to query data about user accounts, roles, projects, and that provide access and basic operations for the resources. REST API also provides an administrator-friendly way to manage the server because it can be run in the text mode and in a shell script.

The documentation of REST API is provided in Swagger, available with TWC installation, where you can find the description of the APIs in both machine-readable and human-readable format. TWCloud REST API documentation in Swagger is accessible at The API document is also bundled with TWCloud installation. You can access it from https://<TWCloud IP>:8111/osmc/swagger

Swagger coming with the TWC installation makes it the most convenient way to issue REST API to the server. It allows logging in and calling to the server from a web browser. While calling to the server, Swagger also shows a cURL command that the user can copy to the command line and execute or in a batch script.

  • No labels