Cumulus API

Welcome to the Cumulus API reference documentation. It describes every endpoint an integration uses: reading and writing objects such as assets and geofences, their sensor values, positions and history, commissioning devices onto them, and managing users. The API is flexible to use, and access can be configured per user down to individual object types and operations.

Transport

All endpoints are served over HTTPS at:

https://cumulus.undagrid.com

Every endpoint in this documentation is given as a path relative to that address, for example GET /v1/{tenant}/assets. HTTP/1.1 and HTTP/2 are supported, and compression is recommended.

All endpoints produce and consume JSON unless stated otherwise.

To keep polling cheap, the list endpoint can return only the objects that changed since the last call in full; see the p parameter of Get multiple objects.

Where to start

• Concepts: tenants, object types and the structure every object shares.
• Authentication and authorisation: obtaining a token, and what a user may do.
• Generic endpoints: reading, writing and querying objects of any type.
• Assets, Geofences, Views and Users and permissions: what is specific to each.
• Sensor values: the form of every sensor value an asset can carry.