Reference Documentation

Design docs, concept definitions, and references for APIs and CLIs.

Reference Documentation

In the reference section, you can find reference documentation for Thingsboard APIs as well as our design docs and rule engine components.


Thingsboard design documentation, clustering mode and actor models are covered in Thingsboard Architecture.

API References

Thingsboard API consist of two main parts: device API and server-side API.

Device API is grouped by supported communication protocols:

Server-side API consist of core REST API and a set of specific APIs that are provided by various plugins:

Rule Engine Components

Explore list of available Rule Engine components: filters, processors, actions and plugins.