# Alarms

## listAlarms

This API is used to list all the alarms generated in OpManager.

### HTTP Method

GET

### API URL

```
http://localhost:8060/api/json/alarm/listAlarms?apiKey=********&deviceName=test1.zoho.com&severity=1&category=Device_Category&entity=sample_entity&alertType=ActiveAlarms&fromTime=2022-05-02 08:00:00&toTime=2022-06-02 18:30:00
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| deviceName | Name of the device for which the alarms should be listed. This can be retrieved using the listDevices API. | String | Allowed values: Any valid device name | No |
| severity | Severity of the alarm. |  | Allowed values: 1 (Critical), 2 (Trouble), 3 (Attention), 4 (Service Down), 5 (Clear)<br>(e.g., severity=1) | No |
| category | Category of the device |  | A valid category name.<br>Allowed Characters: Any letters, numbers and these symbols: . , space ~ ` : \ / - _ | No |
| alertType | Type of the alarms. |  | Allowed values: ActiveAlarms, EventLogAlarms, SyslogAlarms, TrapAlarms, NCMAlarms, NFAAlarms, WebAlarms, FWAAlarms, StorageAlarms, APMAlarms, Server, Network, Virtualization, CorrelatedAlarms.<br>(e.g., alertType=ActiveAlarms) | No |
| fromTime | Start time for the custom time period range. |  | It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M (start of the day).<br>(e.g., fromTime=2022-05-02 08:00:00) | No |
| toTime | End time for the custom time period range. |  | It could be of the format yyyy-mm-dd or yyyy-mm-dd hh:mm:ss. If no time is specified (i.e, yyyy-mm-dd format), the default time will be set to 12 A.M (start of the day).<br>(e.g., toTime=2022-06-02 18:30:00) | No |
| probeName | The name of the Probe. The probe name could be obtained by executing the listProbes API, where the parameter name in the response refers to the probeName. [Applicable only for Central Server] |  | A valid probe name.<br>Allowed: Any combination of letters, numbers, underscores, and spaces. | No |

### Sample Response

HTTP Code: 200

```
{ "alarmPresent": true, "total": 1, "Details":{ "Server": [ { "label": "Attention", "value": 2, "status": 3} ]}, "pageLength": 100, "records": 2, "Acknowledge": "0", "Unacknowledge": "2", "severityVsCount":{ "Attention": 2}, "page": 1, "rowCount": 2, "rows": [ { "categoryString": "Server", "prettyTime": "147 days ago", "statusStr": "Attention", "isSuppressed": false, "displayName": "deviceName1", "lastNote": -1, "technician": "Unacknowledged", "message": "CPU Ready [VMware]'s data collection has been failing continuously", "deviceName": "deviceName1", "statusNum": 3, "suppressedMessage": "", "modTimeLong": 1748980058922, "modTime": "06/03/2025 12:47:38 PM PDT", "alarmId": 307, "eventtype": "Poll Failure", "category": "Server", "entity": "PollFailure_4260", "alarmcode": "PollFailure_Down_4260", "who": "Unacknowledge"}, { "categoryString": "Server", "prettyTime": "147 days ago", "statusStr": "Attention", "isSuppressed": false, "displayName": "deviceName2", "lastNote": -1, "technician": "Unacknowledged", "message": "CPU Utilization [VMware]'s data collection has been failing continuously", "deviceName": "deviceName2", "statusNum": 3, "suppressedMessage": "", "modTimeLong": 1748980058904, "modTime": "06/03/2025 12:47:38 PM PDT", "alarmId": 311, "eventtype": "Poll Failure", "category": "Server", "entity": "PollFailure_4266", "alarmcode": "PollFailure_Down_4266", "who": "Unacknowledge"} ], "notificationEnabled": true}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 100 requests per minute. Exceeding this limit will block requests for 1 minute

## alarmProperties

To list alarm properties of the particular alarm

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/alarm/alarmProperties?apiKey=***************&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | Entity of the alarm for which the alarm properties should be retrieved. This can be retrieved using the listAlarms API. |  | Entity name for which the properties should be retrieved.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll) | Yes |

### Sample Response

HTTP Code: 200

```
{ "statusStr": "Critical", "stageStr": "New", "suppression": "false", "eventtype": "Threshold Down", "previousseverity": "3", "EVENTTYPE": "Threshold Down", "stage": "0", "modTime": "1666785470844", "createTime": "1666785470844", "pollid": "37", "category": "Desktop", "entity": "37_DiskUtilization", "stringpreviousseverity": "", "who": "Unacknowledge"}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## addNotes

This API is used to add notes to an alarm

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/alarm/addNotes?apiKey=***************&entity=sample_entity&notes=sample_notes
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | The entity of the alarm(s) to which the notes should be added. This can be retrieved using the listAlarms API. |  | Comma-separated list of entity names to which the notes should be added.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll) | Yes |
| notes | Notes description to be added |  | Allowed Values: Any letters, numbers, spaces, and these symbols: . ! : @ # % $=> < & + * - \ / ' , _ ( ) ~ ` [ ]{} ^ ; | ? " | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Successfully Added"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## acknowledgeAlarm

This API is used to acknowledge an alarm

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/alarm/acknowledgeAlarm?apiKey=***************&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | Entity of the alarm(s) that should be acknowledged. This can be retrieved using the listAlarms API. |  | Comma-separated list of entity names to be acknowledged.<br>Allowed characters: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Alarm has been successfully Acknowledged"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## unAcknowledgeAlarm

This API is used to unacknowledge an alarm

### HTTP Method

POST

### API URL

```
http://localhost:8060/api/json/alarm/unAcknowledgeAlarm?apiKey=********&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | Entity of the alarm(s) that should be unacknowledged. This can be retrieved using the listAlarms API. |  | Comma-separated list of entity names to be unacknowledged.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Alarm has been successfully UnAcknowledged"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## clearAlarm

This API is used to clear an Alarm.

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/alarm/clearAlarm?apiKey=***************&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | Entity of the alarm(s) that should be cleared. This can be retrieved using the listAlarms API. |  | Comma-separated list of entity names to be cleared.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Alarm has been successfully Cleared!"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## deleteAlarm

This API is used to delete an alarm

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/alarm/deleteAlarm?apiKey=***************&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | The entity of the alarm(s) that should be deleted. This can be retrieved using the listAlarms API. |  | Comma-separated list of entity names to be deleted.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , /<br>(e.g., entity=sampleEntity1_Poll,sampleEntity2_Poll) | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Alarm has been successfully Deleted!"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## ConfigureSuppressAlarm

This API is used to suppress alarms for a specific device.

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/device/ConfigureSuppressAlarm?apiKey=&name=test.abc&suppressInterval=-2&startTime=2024-08-16 16:30&endTime=2024-08-16 16:50
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| name | Name of the device to be suppressed. This can be retrieved using the listDevices API. | String | Allowed values: Any valid device name | Yes |
| suppressInterval | The time period during which the device should be suppressed. |  | Allowed values: 0 (never), -1 (forever), 3600000 (1 hour), 7200000 (2 hours), 28800000 (8 hours), 43200000 (12 hours), 86400000 (1 day), 604800000 (7 days), -2 (Custom Time Period - For Custom Time Period, specify the startTime and endTime parameters in the format YYYY-MM-DD HH:MM)<br>(e.g., suppressInterval=604800000) | Yes |
| startTime | Alarm suppression start time in YYYY-MM-DD HH:MM format.<br>This to be specified only for suppressInterval=-2 |  | Allowed format: YYYY-MM-DD HH:MM<br>Example: 2025-10-24 14:42 | No |
| endTime | Alarm suppression end time in YYYY-MM-DD HH:MM format.<br>To be specified only for suppressInterval=-2 |  | Allowed format: YYYY-MM-DD HH:MM<br>Example: 2025-10-24 14:42 | No |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Alarm Suppression rule has been added successfully"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 20 requests per minute. Exceeding this limit will block requests for 1 minute

## getAnnotation

This API is used to get notes of the alarms

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/alarm/getAnnotation?apiKey=***************&entity=sample_entity
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| entity | The entity of the alarm for which the notes should be retrieved. This can be retrieved using the listAlarms API. |  | Entity name for which the notes should be retrieved.<br>Allowed values: Any letters, numbers, spaces, and these symbols: . ! & : @ # $ - _ ' , / | Yes |

### Sample Response

HTTP Code: 200

```
[ { "notes": "This is a test note", "modTime": 1666786020066, "noteID": 1, "modTimeStr": "26 Oct 2022 05:37:00 PM IST", "entity": "37_DiskUtilization", "who": "admin"}]
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 100 requests per minute. Exceeding this limit will block requests for 1 minute

## updateAlarmNote

This API is used to update notes for an alarm

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/alarm/updateAlarmNote?apiKey=***************&noteID=1&notes=sample_notes
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| noteID | ID of the note to be updated. This can be retrieved using the getAnnotation API. | long | Any valid note id | Yes |
| notes | Notes description to be added |  | Allowed Values: Any letters, numbers, spaces, and these symbols: . ! : @ # % $=> < & + * - \ / ' , _ ( ) ~ ` [ ]{} ^ ; | ? " | Yes |

### Sample Response

HTTP Code: 200

```
{ "result":{ "message": "Note has been successfully updated"}}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 50 requests per minute. Exceeding this limit will block requests for 1 minute

## GetSuppressAlarmDetails

This API is used to retrieve the suppression details for a specific device.

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/device/GetSuppressAlarmDetails?apiKey=***************&name=test.abc
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. |  |  | Yes |
| name | Name of the device for which suppression details are to be retrieved. Device name can be retrieved using the listDevices API. | String | Allowed values: Any valid device name | Yes |

### Sample Response

HTTP Code: 200

```
{ { "List": [ { "configID": 10000000602, "LASTUPDATEDTIME": 1761320552761, "startTime": "24 Oct 2025 09:12:32 PM IST", "endTime": "25 Oct 2025 05:12:32 AM IST", "userName": "admin", "message": "Alarms are suppressed till : 25 Oct 2025 05:12:32 AM IST", "suppressInterval": "28800000"} ]}
```

### Error Response

[View common error responses](https://www.manageengine.com/network-monitoring/help/common-json-errors.html)

**Rate limit:** 20 requests per minute. Exceeding this limit will block requests for 1 minute