Welcome to cloudplan’s documentation!

Check out Getting Started if you have not used this version of the api before.

Note

This page describes the latest version of the cloudplan api with a new endpoint and different authentication than the previous version. The old version of the cloudplan api documentation is available here: https://docs.cloudplan.net/_static/legacy/index.html

Postman Collection

There is a postman collection with all requests described in this documentation. Download here: cloudplan API.postman_collection.json.

To use the collection import it into postman and put your api-key and secret in the authentication tab of the collection settings.

Content of this Documentation

Guides:

• Getting Started

API Reference:

• API Reference
  • List all Root Directories
  • List Folder Content
  • File and Folder Index Objects
  • Create a new Folder
  • Delete Folders and Files
  • Upload a File
  • Get Rows
  • Add Rows
  • Create a Weblink
  • List Weblinks
  • Revoke a Weblink

Concepts:

• Concepts
  • Datatable Object
  • Column Display Types
  • Query Filters
  • Exporter Presets
  • Aggregation Pipeline
  • Weblink Objects
  • Folder Objects