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

# List Alarms

`GET /v1/alarms`

Retrieve a list of alarms.

## Query parameters

- `rootObject` integer — ID of root object for alarm retrieval (0 to retrieve all alarms)
- `includeObjectDetails` boolean — If true, include full source object details in response

## Response `200`

Successful retrieval of alarms.

- object[]
  - `id` integer
  - `severity` integer — Current severity: 0=Normal, 1=Warning, 2=Minor, 3=Major, 4=Critical
  - `state` integer — Alarm state: 0=Outstanding, 1=Acknowledged, 2=Resolved, 3=Terminated
  - `source` integer — Source object ID
  - `sourceName` string — Name of the source object
  - `zoneUIN` integer — Zone UIN of the source object (0 if zoning is disabled)
  - `message` string
  - `repeatCount` integer — Number of times the alarm was raised
  - `commentCount` integer — Number of comments attached to the alarm
  - `helpdeskReference` string — Helpdesk issue reference (empty if not linked)
  - `creationTime` string, date-time
  - `lastChangeTime` string, date-time
  - `ackByUserName` string — Name of the user who acknowledged the alarm (empty if not acknowledged)
  - `resolvedByUserName` string — Name of the user who resolved the alarm (empty if not resolved)
  - `categories` AlarmCategoryReference[] — Alarm categories (as assigned by the event processing policy rule that raised the alarm)
    - `id` integer — Alarm category ID
    - `name` string, nullable — Alarm category name, or null if the category no longer exists
  - `sourceObject` ObjectSummary
    - `alias` string — Object alias
    - `category` integer — Object category ID
    - `class` 'AccessPoint' | 'AgentPolicyLogParser' | 'Asset' | 'AssetGroup' | 'AssetRoot' | 'BusinessService' | 'BusinessServiceProto' | 'BusinessServiceRoot' | 'Chassis' | 'Cluster' | 'Condition' | 'Container' | 'Dashboard' | 'DashboardGroup' | 'DashboardRoot' | 'Generic' | 'Interface' | 'MobileDevice' | 'Network' | 'NetworkMap' | 'NetworkMapGroup' | 'NetworkMapRoot' | 'NetworkService' | 'Node' | 'NodeLink' | 'Rack' | 'Report' | 'ReportGroup' | 'ReportRoot' | 'Sensor' | 'ServiceCheck' | 'ServiceRoot' | 'Subnet' | 'Template' | 'TemplateGroup' | 'TemplateRoot' | 'VPNConnector' | 'Zone'
    - `guid` string, uuid — Object GUID
    - `id` integer — Object ID
    - `ipAddress` InetAddress
      - `family` integer — IP address family
      - `address` integer — IP address
      - `prefixLength` integer — IP address prefix length
    - `isInMaintenanceMode` boolean — true if object is in maintenance mode
    - `isMaintenanceApplicable` boolean — true if object can be placed into maintenance mode
    - `isMaintenanceScheduled` boolean — true if object has pending scheduled maintenance
    - `name` string — Object name
    - `timestamp` string, date-time — Object last change timestamp
    - `status` 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8

---

[API](https://skmtc.net/netxms/apis/netxms-api.md) · [All operations](https://skmtc.net/netxms/apis/netxms-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/netxms/netxms-api/versions/ee1f54ee3abd/schema)