---
title: "Get Alarm (getAlarmById)"
method: GET
path: "/api/alarm/{alarmId}"
tags: ["alarm-controller"]
---

# Get Alarm (getAlarmById)

`GET /api/alarm/{alarmId}`

Fetch the Alarm object based on the provided Alarm Id. If the user has the authority of 'Tenant Administrator', the server checks that the originator of alarm is owned by the same tenant. If the user has the authority of 'Customer User', the server checks that the originator of alarm belongs to the customer.

## Path parameters

- `alarmId` string, required

## Response `200`

OK

- Alarm
  - `tenantId` TenantId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT', required — string
  - `customerId` CustomerId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'CUSTOMER', required — string
  - `type` string, required — representing type of the Alarm
  - `originator` EntityId, required
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'TENANT' | 'CUSTOMER' | 'USER' | 'DASHBOARD' | 'ASSET' | 'DEVICE' | 'ALARM' | 'RULE_CHAIN' | 'RULE_NODE' | 'ENTITY_VIEW' | 'WIDGETS_BUNDLE' | 'WIDGET_TYPE' | 'TENANT_PROFILE' | 'DEVICE_PROFILE' | 'ASSET_PROFILE' | 'API_USAGE_STATE' | 'TB_RESOURCE' | 'OTA_PACKAGE' | 'EDGE' | 'RPC' | 'QUEUE' | 'NOTIFICATION_TARGET' | 'NOTIFICATION_TEMPLATE' | 'NOTIFICATION_REQUEST' | 'NOTIFICATION' | 'NOTIFICATION_RULE' | 'QUEUE_STATS' | 'OAUTH2_CLIENT' | 'DOMAIN' | 'MOBILE_APP' | 'MOBILE_APP_BUNDLE' | 'CALCULATED_FIELD' | 'JOB' | 'ADMIN_SETTINGS' | 'AI_MODEL' | 'API_KEY', required
  - `severity` 'CRITICAL' | 'MAJOR' | 'MINOR' | 'WARNING' | 'INDETERMINATE', required — Alarm severity
  - `acknowledged` boolean, required — Acknowledged
  - `cleared` boolean, required — Cleared
  - `assigneeId` UserId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'USER', required — string
  - `startTs` integer — Timestamp of the alarm start time, in milliseconds
  - `endTs` integer — Timestamp of the alarm end time(last time update), in milliseconds
  - `ackTs` integer — Timestamp of the alarm acknowledgement, in milliseconds
  - `clearTs` integer — Timestamp of the alarm clearing, in milliseconds
  - `assignTs` integer — Timestamp of the alarm assignment, in milliseconds
  - `details` unknown
  - `propagate` boolean — Propagation flag to specify if alarm should be propagated to parent entities of alarm originator
  - `propagateToOwner` boolean — Propagation flag to specify if alarm should be propagated to the owner (tenant or customer) of alarm originator
  - `propagateToTenant` boolean — Propagation flag to specify if alarm should be propagated to the tenant entity
  - `propagateRelationTypes` string[] — JSON array of relation types that should be used for propagation. By default, 'propagateRelationTypes' array is empty which means that the alarm will be propagated based on any relation type to parent entities. This parameter should be used only in case when 'propagate' parameter is set to true, otherwise, 'propagateRelationTypes' array will be ignored.
  - `id` AlarmId
    - `id` string, uuid, required — ID of the entity, time-based UUID v1
    - `entityType` 'ALARM', required — string
  - `createdTime` integer — Timestamp of the alarm creation, in milliseconds
  - `name` string, required — representing type of the Alarm
  - `status` 'ACTIVE_UNACK' | 'ACTIVE_ACK' | 'CLEARED_UNACK' | 'CLEARED_ACK', required — status of the Alarm

---

[API](https://skmtc.net/thingsboard/apis/thingsboard-rest-api.md) · [All operations](https://skmtc.net/thingsboard/apis/thingsboard-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/thingsboard/thingsboard-rest-api/revisions/40169ccdec5c/schema)