capability: thingsboard.alarms
version: 0.1.0
description: Manage IoT alarms — list, acknowledge, clear, assign, and comment.
provider: thingsboard
api: thingsboard-alarms-api
openapi: ../openapi/thingsboard-alarms-openapi.yml
operations:
  - id: getAlarm
    method: GET
    path: /api/alarm/{alarmId}
    summary: Retrieve an alarm by id.
  - id: ackAlarm
    method: POST
    path: /api/alarm/{alarmId}/ack
    summary: Acknowledge an alarm.
  - id: clearAlarm
    method: POST
    path: /api/alarm/{alarmId}/clear
    summary: Clear an alarm.
  - id: assignAlarm
    method: POST
    path: /api/alarm/{alarmId}/assign/{assigneeId}
    summary: Assign an alarm to a user.
auth:
  - bearerAuth
  - apiKeyAuth
tags:
  - IoT
  - Alarms
  - Operations