---
title: "List alarms"
method: GET
path: "/alarms"
tags: ["Alarms"]
---

# List alarms

`GET /alarms`

Returns alarms with optional filtering.
Supports filtering by object, state, time range, key, and message.

## Query parameters

- `objectId` integer
- `objectGuid` string, uuid
- `includeChildObjects` boolean
- `state` string
- `createdBefore` integer
- `createdAfter` integer
- `updatedBefore` integer
- `updatedAfter` integer
- `key` string
- `keyRegex` string
- `message` string
- `resolveReferences` boolean

## Response `200`

List of alarms

- object
  - `alarms` Alarm[]
    - `id` integer
    - `parentId` integer
    - `creationTime` integer
    - `lastChangeTime` integer
    - `sourceObjectId` integer
    - `sourceEventCode` integer
    - `sourceEventId` integer
    - `dciId` integer
    - `currentSeverity` integer
    - `originalSeverity` integer
    - `repeatCount` integer
    - `state` integer — 0: OUTSTANDING, 1: ACKNOWLEDGED, 2: RESOLVED, 3: TERMINATED
    - `message` string
    - `key` string
    - `helpDeskState` integer
    - `helpDeskRef` string
    - `acknowledgedByUser` integer
    - `resolvedByUser` integer
    - `terminatedByUser` integer
    - `ackTimeout` integer
    - `categories` object[]
      - `id` integer
      - `name` string
    - `sourceObject` AbstractObject
      - `objectId` integer
      - `guid` string, uuid
      - `objectName` string
      - `alias` string
      - `nameOnMap` string
      - `objectClass` integer
      - `categoryId` integer
      - `flags` integer
      - `status` 'NORMAL' | 'WARNING' | 'MINOR' | 'MAJOR' | 'CRITICAL' | 'UNKNOWN' | 'UNMANAGED' | 'DISABLED' | 'TESTING'
      - `isDeleted` boolean
      - `inMaintenanceMode` boolean
      - `maintenanceInitiatorId` integer
      - `comments` string
      - `commentsSource` string
      - `geolocation` Geolocation
        - `type` integer — 0: UNSET, 1: MANUAL, 2: GPS, 3: NETWORK
        - `latitude` number, double
        - `longitude` number, double
        - `accuracy` integer — Accuracy in meters
        - `timestamp` integer — Unix timestamp
      - `postalAddress` PostalAddress
        - `country` string
        - `region` string
        - `city` string
        - `district` string
        - `streetAddress` string
        - `postcode` string
      - `mapImage` string, uuid
      - `drillDownObjectId` integer
      - `trustedObjects` integer[]
      - `inheritAccessRights` boolean
      - `accessList` AccessListElement[]
        - `userId` integer
        - `accessRights` integer — Bit flags. Attribute is 64 bit wide since schema version 70.25. All 32 low bits are allocated, including bit 31 (0x80000000) for EXECUTE_SCRIPT. - 0x00000001: READ - 0x00000002: MODIFY - 0x00000004: CREATE - 0x00000008: DELETE - 0x00000010: READ_ALARMS - 0x00000020: ACL - 0x00000040: UPDATE_ALARMS - 0x00000080: SEND_EVENTS - 0x00000100: CONTROL - 0x00000200: TERM_ALARMS - 0x00000400: PUSH_DATA - 0x00000800: CREATE_ISSUE - 0x00001000: DOWNLOAD - 0x00002000: UPLOAD - 0x00004000: MANAGE_FILES - 0x00008000: MAINTENANCE - 0x00010000: READ_AGENT - 0x00020000: READ_SNMP - 0x00040000: SCREENSHOT - 0x00080000: EDIT_MNT_JOURNAL - 0x00100000: CONFIGURE_AGENT - 0x00200000: EDIT_COMMENTS - 0x00400000: EDIT_RESP_USERS - 0x00800000: DELEGATED_READ - 0x01000000: MANAGE_POLICIES - 0x02000000: MANAGE_INCIDENTS - 0x04000000: READ_CREDENTIALS - 0x08000000: QUERY_WEBSVC - 0x10000000: UPLOAD_DEVICE_CONFIG - 0x20000000: READ_DEVICE_CONFIG - 0x40000000: READ_DC_CONFIG - 0x80000000: EXECUTE_SCRIPT
      - `creationTime` integer
      - `parents` integer[]
      - `children` integer[]
      - `dashboards` integer[]
      - `customAttributes` object
      - `urls` object[]
      - `responsibleUsers` integer[]
      - `objectClassName` string
    - `sourceEventName` string
    - `acknowledgedByUserName` string
    - `resolvedByUserName` string
    - `terminatedByUserName` string
    - `dci` DciValue
      - `id` integer
      - `nodeId` integer
      - `name` string
      - `description` string
      - `value` string
      - `timestamp` integer
      - `status` integer
      - `dataType` integer
      - `errorCount` integer
      - `activeThresholdSeverity` integer
    - `zoneUIN` integer
    - `zoneName` string

## Other responses

- `401` — Access denied

## Changes

> 15 revisions in range; 12 could not be searched.

- **2023-02-23** `9c09a2aad349` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/netxms/apis/netxms-rest-api/changes/alarms/get.md)

---

[API](https://skmtc.dev/netxms/apis/netxms-rest-api.md) · [All operations](https://skmtc.dev/netxms/apis/netxms-rest-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/netxms/netxms-rest-api/revisions/04789afedcb3/schema)