How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
ThingsBoard

ThingsBoard alarm-controller API

Alarm

Documentation Provider Profile APIs.io OpenAPI GitHub

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.2.0, at version 4.3.0.3DEMO.

Requests are made against 2 base URLs: https://demo.thingsboard.io, http://localhost:8080.

14 operations 13 paths 12 schemas 2 DELETE8 GET4 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
4.3.0.3DEMO
Servers
https://demo.thingsboard.io
http://localhost:8080
Authentication
HTTP Loginpassword, API Key
Contact
ThingsBoard team
License
Apache 2.0
Resource Areas
1

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 / Password
  • API_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-controller 14

Alarm

POST
/api/alarm
Create or Update Alarm (saveAlarm)
saveAlarm body → 200
POST
/api/alarm/{alarmId}/clear
Clear Alarm (clearAlarm)
clearAlarm 1 param → 200
POST
/api/alarm/{alarmId}/assign/{assigneeId}
Assign/Reassign Alarm (assignAlarm)
assignAlarm 2 params → 200
POST
/api/alarm/{alarmId}/ack
Acknowledge Alarm (ackAlarm)
ackAlarm 1 param → 200
GET
/api/v2/alarms
Get All Alarms (getAllAlarmsV2)
getAllAlarmsV2 11 params → 200
GET
/api/v2/alarm/{entityType}/{entityId}
Get Alarms (getAlarmsV2)
getAlarmsV2 13 params → 200
GET
/api/alarms
Get All Alarms (getAllAlarms)
getAllAlarms 11 params → 200
GET
/api/alarm/{entityType}/{entityId}
Get Alarms (getAlarms)
getAlarms 13 params → 200
GET
/api/alarm/{alarmId}
Get Alarm (getAlarmById)
getAlarmById 1 param → 200
DELETE
/api/alarm/{alarmId}
Delete Alarm (deleteAlarm)
deleteAlarm 1 param → 200
GET
/api/alarm/types
Get Alarm Types (getAlarmTypes)
getAlarmTypes 4 params → 200
GET
/api/alarm/info/{alarmId}
Get Alarm Info (getAlarmInfoById)
getAlarmInfoById 1 param → 200
GET
/api/alarm/highestSeverity/{entityType}/{entityId}
Get Highest Alarm Severity (getHighestAlarmSeverity)
getHighestAlarmSeverity 5 params → 200
DELETE
/api/alarm/{alarmId}/assign
Unassign Alarm (unassignAlarm)
unassignAlarm 1 param → 200

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), AlarmAssignee (4 properties), PageDataAlarmInfo (4 properties). Each schema is shown below with its type and property counts.

UserId
object
2 properties 2 required
TenantId
object
2 properties 2 required
PageDataEntitySubtype
object
4 properties
PageDataAlarmInfo
object
4 properties
AlarmAssignee
object
4 properties
EntitySubtype
object
3 properties
JsonNode
A value representing the any type (object or primitive)
AlarmId
object
2 properties 2 required
AlarmInfo
object
26 properties 7 required
Alarm
object
22 properties 7 required
CustomerId
object
2 properties 2 required
EntityId
object
2 properties 2 required

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

thingsboard-alarm-controller-api-openapi.yml Raw ↑

Other APIs ThingsBoard publishes across the network.

ThingsBoard admin-controller API
AE Profile APIs.io
ThingsBoard ai-model-controller API
AE Profile APIs.io
ThingsBoard alarm-comment-controller API
AE Profile APIs.io
ThingsBoard api-key-controller API
AE Profile APIs.io
ThingsBoard asset-controller API
AE Profile APIs.io
ThingsBoard asset-profile-controller API
AE Profile APIs.io
ThingsBoard audit-log-controller API
AE Profile APIs.io
ThingsBoard auth-controller API
AE Profile APIs.io
ThingsBoard calculated-field-controller API
AE Profile APIs.io
ThingsBoard component-descriptor-controller API
AE Profile APIs.io
ThingsBoard customer-controller API
AE Profile APIs.io
ThingsBoard dashboard-controller API
AE Profile APIs.io
#alarm-controller
← Back to T APIs
API Details
ID
thingsboard:thingsboard-alarm-controller-api
Server
https://demo.thingsboard.io
Docs
https://thingsboard.io/docs/reference/rest-api/
Provider
ThingsBoard
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=thingsboard-alarm-controller-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/thingsboard-alarm-controller-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of ThingsBoard alarm-controller API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.