ThingsBoard icon

ThingsBoard

Interact with ThingsBoard REST API

Alarm → Get Info by ID

AI-generated

Summary

Get alarm information by its ID

Inputs

  • authentication — Authentication method (API Key or Username/Password)
  • alarmId (required) — Alarm ID to retrieve, e.g., "784f394c-42b6-435a-983c-b7beff2784f9"

Output shape

a single alarm object

Returns the full alarm record (including fields like id, severity, status, etc.) or throws an error if the ID is invalid.

Examples

Example 1: Fetch alarm details by ID

Authentication: API Key; Alarm ID: 784f394c-42b6-435a-983c-b7beff2784f9

Example 2: Fetch alarm details using Username/Password

Authentication: Username / Password; Alarm ID: 12345

Example 3: Invalid alarm ID triggers error

Authentication: API Key; Alarm ID: invalid-uuid

Links

Discussion