ThingsBoard alarm-controller API
Alarm
ThingsBoard alarm-controller API is one of 58 APIs that ThingsBoard publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
This API exposes 11 JSON Schema definitions.
Tagged areas include alarm-controller. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 11 JSON Schemas.
This API exposes 14 operations across 13 paths, and defines 12 schemas. It is described by OpenAPI 3.1.0, at version 4.3.0.3DEMO.
Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 2
ThingsBoard alarm-controller API declares
2 security schemes
for authenticating requests.
It uses HTTP loginpassword authentication (HTTP login form).
An API key is passed in the header as X-Authorization (API key form).
HTTP login form— Enter Username / PasswordAPI key form— Enter the API key value with 'ApiKey' prefix in format: ApiKey Example: ApiKey tb5te51SkLRYpjGrujUGwqkjFvooWBlQpVe2An2Dr3w13wjfxDW NOTE: Use only ONE authentic…
Paths & Operations 14
Across 13 paths, the API surfaces 14 operations — 2 DELETE, 8 GET, 4 POST. Each is listed below with its method, path, parameters, and response codes.
Alarm
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are AlarmInfo (26 properties), Alarm (22 properties), PageDataEntitySubtype (4 properties), AlarmAssignee (4 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from ThingsBoard 12
Other APIs ThingsBoard publishes across the network.