ThingScale IoT message broker
ThingScale provides a messaging system for IoT connected devices. The API is used to retrieve events, users, devices, sessions, and channels in JSON format. ThingScale supports TLS payload encryption, scheme-less and cyclic data sampling, and trigger-based notifications. MQTT is the preferred messaging protocol.
ThingScale IoT message broker endpoints
| Method | Endpoint | Description |
|---|---|---|
| Channel service | ||
| PUT |
Update a Channel /channel/{channel_id} |
Special HeaderDescription X-TAGNAME (string) tagname as string (NOTE)Tag name is created when you want to put data containing tags in the channel. |
| DELETE |
Delete a Channel /channel/{channel_id} |
Special HeaderDescription X-TAGNAME (string) tagname as string (NOTE)Tag name is created when you want to put data containing tags in the channel. |
| POST |
Create a New Channel /channel/{channel_id} |
Channel service is accessing for time series data storage channel management when it is associated with the device. To access the stream data stored in the channel, use Stream… |
| GET |
List All channels /channel/{channel_id} |
Special HeaderDescription X-WITHTAG (boolean) show tags with channel (NOTE)Tag name is created when you want to put data containing tags in the channel. |
| Device service | ||
| POST |
Create a New Device /device/{device_id} |
Device service manages the device registry of ThingScale, aggregates information about all of the devices. Each device accumulates the time series data to have been created by… |
| PUT |
Update a Device /device/{device_id} |
Device service manages the device registry of ThingScale, aggregates information about all of the devices. Each device accumulates the time series data to have been created by… |
| DELETE |
Delete a Device /device/{device_id} |
Device service manages the device registry of ThingScale, aggregates information about all of the devices. Each device accumulates the time series data to have been created by… |
| GET |
List All Devices /device/{device_id} |
Device service manages the device registry of ThingScale, aggregates information about all of the devices. Each device accumulates the time series data to have been created by… |
| Stream service | ||
| GET |
Retrieve streams /stream/{channel_id} |
Special HeaderDescription X-TAGNAME (string) tagname as string X-STARTTIME (string) time range as start // YYYY-MM-DD hh:ss or last X-ENDTIME (string,required) time range as end… |
| POST |
Write streams /stream/{channel_id} |
Stream service provides access to time-series data that has been accumulated in the channel. Before you can use the Stream service, you must have completed the following steps.… |
| Event service | ||
| DELETE |
Delete an Event /event/{event_id} |
Event service is by setting a threshold for the stream of the channel, make the notification to the email or an external system. Before Event service use, please make sure that… |
| POST |
Create a New Event /event/{event_id} |
Event service is by setting a threshold for the stream of the channel, make the notification to the email or an external system. Before Event service use, please make sure that… |
| GET |
List events /event/{event_id} |
Event service is by setting a threshold for the stream of the channel, make the notification to the email or an external system. Before Event service use, please make sure that… |
| PUT |
Update an Event /event/{event_id} |
Event service is by setting a threshold for the stream of the channel, make the notification to the email or an external system. Before Event service use, please make sure that… |
| User service | ||
| GET |
Retrieve user information /user/ |
User service provides the management functions of the user profile. |
| PUT |
Update a User information /user/ |
User service provides the management functions of the user profile. |
| Publish service | ||
| POST |
Publish message /publish/{device_id} |
Publish service provides message delivery function to the device from ThingScale. By Publish service, it will deliver the command to the device that are subscribed to the MQTT… |
| Session service | ||
| GET |
List active sessions /session |
Session service provides showing pub/sub status to ThingScale's built-in message broker. Both MQTT and WebSocket clients shown in session. About how to see the session If Publish… |
ThingScale IoT message broker pricing
| Plan | Price | Rate limit | Quotas |
|---|---|---|---|
| BASIC | Free | — |
|