Welcome to cloudplan’s API documentation!

Getting Started

If you are new you can check out the Quickstart

Authentication

Each API call is authenticated with a session id, that can be obtained with the Login request and has to be sent in the HTTP header:

session_id: 5BBC7AEA7AAF01733BC25ED64DBC9D38

Layout

The cloudplan API on a high level is divided into modules that concern different things like users or folder.

The api functions are executed in the context of the currently logged in user (determined through the session id). So a api/user/me request will return information about yourself, the current user.

API Modules:

• File
  • Upload Start
  • Upload Data
  • Upload Cancel
  • Upload Finish
  • Get Unifinished Uploads
• Folder
  • Create
  • Ls
  • Root
  • Details
  • Delete
  • Rename
  • Get Many
• User
  • Login
  • Me
  • Create
  • Get Changelog
  • Get Many
  • Session Create Foreign User
• Weblink
  • Create
  • Get
  • Revoke
• Workflow
  • List
  • Details
  • Create
  • Start
  • Update
  • Replace participants
  • Remove Participants
  • Add File
  • Add File Json
  • Replace files
  • Values
  • Values Update
  • Fields
  • Update Fields
• Organisation
  • Get Users
• Docclass
  • Create
  • Delete
  • Update
  • Ls
  • Move
  • Restore
  • Assign Files
  • Unassign Files
  • Assign Workflows
  • Unassign Workflows
• Search
  • Search
  • Create Tag
  • Add Tag
  • Get Tags
  • Update Tag
  • Remove Tag
  • Delete Tag
  • Restore Tag
  • Workflow
• Tables
  • List
  • Create
  • Add Rows
  • Get Rows
  • Delete Rows
  • Update Values

Other

• Quickstart
• Tutorials
• API
• Node Errors