REST APIs

The Platform REST API provides endpoints to return status data and allows active management of the Cedalo MQTT Platform. Mosquitto administrators can use the REST API to perform automated actions, which would normally be administered via the Cedalo Platform UI.

General

The base path of a REST endpoint is platform.cedalo.cloud. So for example to list all available projects send a GET request, with a valid API token (see below), to https://platform.cedalo.cloud/api/projects.

All required IDs are received REST-like. That means to get (e.g.) a projectId first request a list of projects, from the response extract the ID of interest and use that for subsequent calls.

Authenticate with API Token

Authenticating is achieved using API Tokens. These must be created via the Cedalo Platform UI. For a detailed explanation on how to create and manage API Tokens see here.

Add the created token to API requests as a bearer token for authentication.

Available APIs

• Access Control
• Brokers
• Client Control
• Client Inspection
• Clusters
• Projects
• Streams
• Tokens
• Topic Tree
• Users