---
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'
    - `effectiveRights` EffectiveRights — Access rights the calling user effectively has on the object. Rights are resolved at the object in this order: if an access control entry names the user directly, that entry alone is used; otherwise the entries for all groups the user belongs to are combined; otherwise, if the object is set to inherit, the effective rights resolved independently on each parent object are combined. An entry granting no rights still counts as a match: a user entry granting nothing suppresses both groups and parents, while a group entry granting nothing suppresses only parents and the other matching groups are still combined. This is the same set of rights NXCP clients obtain with CMD_GET_EFFECTIVE_RIGHTS. Every right is always present as separate boolean attribute. Value is specific to the calling user rather than part of the object's stored state, and is ignored if present in a request body.
      - `read` boolean — Read object (see it in object listings and read its basic attributes)
      - `modify` boolean — Modify object configuration
      - `createChildObjects` boolean — Create child objects
      - `delete` boolean — Delete object
      - `viewAlarms` boolean — View alarms associated with the object
      - `accessControl` boolean — Read and modify object's access control list
      - `updateAlarms` boolean — Acknowledge and update alarms associated with the object
      - `sendEvents` boolean — Send events on behalf of the object
      - `control` boolean — Execute control operations on the object - agent commands, wake-on-LAN, object tools, SSH commands, and TCP proxy. Does not cover changing management status, which requires "modify".
      - `terminateAlarms` boolean — Terminate and resolve alarms associated with the object
      - `pushData` boolean — Push data collection values to the object
      - `createHelpdeskTicket` boolean — Create helpdesk tickets from alarms associated with the object
      - `downloadFiles` boolean — Download files from the node
      - `uploadFiles` boolean — Upload files to the node
      - `manageFiles` boolean — Manage files on the node (rename, move, delete)
      - `controlMaintenanceMode` boolean — Enter and leave maintenance mode
      - `readAgentData` boolean — Read data provided by NetXMS agent
      - `readSnmpData` boolean — Read data provided via SNMP
      - `takeScreenshot` boolean — Take screenshot on the node
      - `editMaintenanceJournal` boolean — Create and edit maintenance journal entries
      - `configureAgent` boolean — Change agent configuration on the node
      - `editComments` boolean — Edit object comments
      - `manageResponsibleUsers` boolean — Manage list of users responsible for the object
      - `delegatedRead` boolean — Read the object indirectly when it is reached through a dashboard or network map the user is allowed to read, without holding "read" on the object itself
      - `managePolicies` boolean — Manage agent policies (template objects only)
      - `manageIncidents` boolean — Manage incidents associated with the object
      - `readCredentials` boolean — Read object's credentials (SNMP communities, agent secrets, and similar)
      - `queryWebService` boolean — Query web services defined on the node
      - `uploadDeviceConfig` boolean — Upload configuration to network device
      - `readDeviceConfig` boolean — Read configuration of network device
      - `readDataCollectionConfig` boolean — Read data collection configuration
      - `executeScript` boolean — Execute ad-hoc scripts in the context of the object
    - `guid` string, uuid — Object GUID
    - `id` integer — Object ID
    - `ipAddress` InetAddress
      - `family` integer — IP address family
      - `address` string — IP address in text form. Omitted entirely for unset (AF_UNSPEC) addresses.
      - `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/revisions/d2e5c5ea6e4c/schema)