# Availability

## getPingResponse

ICMP/Ping response for the given device.

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/device/getPingResponse?apiKey=***************&deviceName=xxx.xxx.xx.x
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| deviceName | Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response. | String | - | Yes |
| fromAddDevice | Is Ping response from Add Device/Server Page | Boolean | - | No |
| isBulk | For Bulk ping response in Inventory Page | Boolean | - | No |
| fromWANLink | Is Ping response from Add WAN Link Page | Boolean | - | No |

### Sample Response

HTTP Code: 200

```json
{ "PingResponse":{ "Details": "Pinging 127.0.0.1 with 32 bytes of data: Reply from 127.0.0.1: bytes=32 time=21ms TTL=251 Ping statistics for 127.0.0.1: Packets: Sent=1, Received=1, Lost=0 (0% loss), Approximate round trip times in milli-seconds: Minimum=21ms, Maximum=21ms, Average=21ms"}}
```

### Error Response

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

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

## getTraceResponse

Trace route command response for the given device

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/device/getTraceResponse?apiKey=***************&deviceName=xxx.xxx.xx.x
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| deviceName | Name of the device - Managed Entity name as seen in the URL of device snapshot page OR 'deviceName' property value in the listDevices API response. | String | - | Yes |
| fromWANLink | Is Trace Response from Add WAN Link Page | String | - | No |

### Sample Response

HTTP Code: 200

```json
{ "TraceResponse":{ "Details": "Tracing route to 127.0.0.1 over a maximum of 30 hops 1 8 ms 9 ms 3 ms 127.0.0.1 2 1 ms 1 ms 1 ms 127.0.0.1 3 20 ms 20 ms 20 ms 127.0.0.1 4 22 ms 21 ms 22 ms 127.0.0.1 5 21 ms 20 ms 20 ms 127.0.0.1 Trace complete."}}
```

### Error Response

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

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

## getDownDevices

Lists the devices that are currently in down state and having device status as 'critical'

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/discovery/getDownDevices?apiKey=******************
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |

### Sample Response

HTTP Code: 200

```json
{ "DownDevices":{ "Details": [ { "name": "127.0.0.1", "type": "HPSwitch 3900X", "category": "Switch", "displayName": "SwitchDevice_SP"}, { "name": "127.0.0.2", "type": "Windows Server 2018", "category": "Server", "displayName": "AppServer-04"}, { "name": "UserPC_Michael", "type": "Linux RedHat", "category": "Server", "displayName": "127.0.0.3"} ]}}
```

### 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 5 minutes

## getAvailabilityGraphData

Fetches the Availability graphs for the given device or interface.

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/device/getAvailabilityGraphData?apiKey=******************&isFluidic=true&name=opmserver.mydomain.com
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| name | Name of the device or interface - Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value of listDevices API or 'interfaceName' property value in the listInterfaces API response [Example: opmserver.mydomain.com or IF-xx.xx.24.223-115] | String | - | Yes |
| isFluidic | Set value as TRUE by default (for internal purpose) | Boolean | - | Yes |
| instance | Set instance=Interface if the Availability graph is requested for the interface. Mandatory field if the interface data is being fetched. This API can also be used to fetch availability of other monitors. [Example: Interface\|URL\|winService\|service\|process] | String | Allowed values: Interface, URL, winService, service, process, MerakiUplink, WANLinkMonitor | No |
| elementID | This is the unique ID column fetched from managedobject table | Long | - | No |

### Sample Response

HTTP Code: 200

```json
{ "uptimeData":{ "Today": 100, "Yesterday": 100, "This Week": 100, "Last Week": 100, "This Month": 99.98, "Last Month": 100, "This Quarter": 99.98, "Last Quarter": 100, "This Year": 99.98, "Last Year": 0}, "availabilityData": [ { "name": "Last 24 Hours", "points": [ { "y": 100, "x": 1661392800000, "toolTipKey": "Aug 25, 12:00 AM", "color": "#1A8F47"} ]} ]}
```

### 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

## listDownTimeSchedules

Provides the list of downtime schedules created in OpManager.

### HTTP Method

GET

### API URL

```
https://localhost:8060/api/json/admin/listDownTimeSchedules?apiKey=****************&callAction=settings
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| callAction | Page from where this action takes place | String | - | Yes |

### Sample Response

HTTP Code: 200

```json
[ { "MODIFIED_BY": "admin", "MODIFIED_TIME_STR": "at Oct 7, 2025 11:42", "type": "Once", "nextscheduledtime": "Tue, Oct 7, 2025 12:00:00", "statusNum": "1", "ADDED_TIME": "1759817559532", "MODIFIED_TIME": "1759817559532", "suppressType": "Monitoring", "name": "DemoSchedule", "id": "1", "ADDED_BY": "admin", "ADDED_TIME_STR": "at Oct 7, 2025 11:42", "status": "Enabled"}]
```

### 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

## addDowntimeSchedule

Allows you to schedule downtimes for groups and devices.

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/admin/addDowntimeSchedule?apiKey=&operation=Add&scheduleName=FirmwareUpgrade&status=Enabled&scheduleDesc=&recurrence=OnceOnly&selectDevicesMethod=Device&once_startat=2024-07-10 00:00&once_endat=2024-07-11 04:00&selectedDevices=10.5.5.1,30.30.30.6,opm-sql
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| operation | Add (to create new downtime scheduler) | String | Allowed values: Add, Edit | Yes |
| scheduleName | Name of the schedule (Strig value) | String | Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_) | Yes |
| status | Enabled/Disabled | String | Allowed values: Enabled, Disabled | Yes |
| scheduleDesc | Downtime scheduler description (Optional) | String | Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), dot(.), slash(/), pipe(\|), question mark(?), hyphen(-), tilde(~) | No |
| recurrence | OnceOnly/Daily | String | Allowed values: OnceOnly, Daily, Weekly, Monthly | Yes |
| selectDevicesMethod | Device | String | Allowed values: Category, BV, Device, URL, GROUP | Yes |
| selectedCateg | Device category (applicable only if selectDevicesMethod is 'Category') | String | Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_), dot(.), slash(/), pipe(\|), question mark(?), hyphen(-), tilde(~) | No |
| selectedBV | Business view name suffixed with '_bv' (applicable only if selectDevicesMethod is 'Business View') | String | - | No |
| selectedDevices | Device IP (comma-separated values) | String | - | No |
| selectedURL | URL Monitor name (applicable only if selectDevicesMethod is 'URLs') | String | - | No |
| selectedLogicalGroups | Devices Group name (comma-separated values) | String | Allowed characters: A-Z, a-z, all Unicode letters, 0-9, space( ), underscore(_), hyphen(-), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), backslash(\), slash(/), single quote('), comma(,) | No |
| once_startat | Start date & time (applicable only if recurrence is 'OnceOnly') | String | Allowed characters: Digits(0-9), hyphen(-), space( ), colon(:) | No |
| once_endat | End date & time (applicable only if recurrence is 'OnceOnly') | String | Allowed characters: Digits(0-9), hyphen(-), space( ), colon(:) | No |
| startday | Start day of the week (applicable only for Daily) | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| endday | End day of the week (applicable only for Daily) | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| from_time | Start date & time (applicable only if recurrence is 'Daily') | String | Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59) | No |
| to_time | End date & time (applicable only if recurrence is 'Daily') | String | Allowed values: 00:00-23:59 (hours 00-23, minutes 00-59) | No |
| daily_effectfrom | Downtime scheduler start date & time (applicable only if recurrence is 'Daily') | String | Allowed values: year-month-date (0000-9999 for year, 01-12 for month, 01-31 for date) | No |
| from_hrs | Start hour (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00-23 | No |
| to_hrs | End hour (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00-23 | No |
| from_mins | Start Minutes (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00-59 | No |
| to_mins | End minutes (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00-59 | No |
| monthlyType | monthlyDate \| monthlyDay (applicable only if recurrence is 'Monthly') | String | Allowed values: monthlyDate, monthlyDay | No |
| weekOfMonth | Week of the month | String | Allowed values: First, Second, Third, Fourth, Last | No |
| weekday | Day of the week (applicable only if recurrence is 'Monthly' and monthlyType is 'monthlyDay') | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1-31, 32 | No |
| mailID | Email id to which the report should be sent | String | Allowed characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), dot(.), plus(+), single quote('), slash(/), at(@), comma(,), space( ) | No |
| suppressType | To Suppress Alarm or Monitoring | String | Allowed values: Alarm, Monitoring | No |
| timeZone | Time Zone | String | Allowed characters: A-Z, a-z, 0-9, underscore(_), hyphen(-), slash(/) | No |
| stopDTS | Stop downtime Scheule. By default, it is false | Boolean | - | No |
| selectedValue | Selected values | String | Allowed characters: A–Z, a–z, 0–9, underscore(_), hyphen(-), dot(.), plus(+), single quote('), slash(/), at(@), comma(,), space( ) | No |

### Sample Response

HTTP Code: 200

```json
{ "result":{ "message": "Downtime Scheduler has been added successfully.", "scheduleID": 7}}
```

### 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

## updateDowntimeSchedule

Used to update downtime schedule.

### HTTP Method

POST

### API URL

```
http://localhost:8060/api/json/admin/updateDowntimeSchedule?operation=Edit&MS_INSTANCEID=14&scheduleId=14
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| operation | Edit will be sent by default (Edit). | String | Allowed values: Add, Edit | Yes |
| MS_INSTANCEID | Maintenance schedule instance ID | long | - | Yes |
| scheduleId | Downtime schedule ID | long | - | Yes |
| scheduleName | Name of the schedule (Strig value) | String | Allowed characters: A–Z, a–z, 0–9, space( ), underscore(_) | Yes |
| status | Enabled/Disabled | String | Allowed values: Enabled, Disabled | Yes |
| scheduleDesc | Downtime scheduler description (Optional) | String | Allowed characters: A–Z, a–z, 0–9, space( ), underscore(_), dot(.), slash(/), pipe(\|), question mark(?), hyphen(-), tilde(~) | No |
| recurrence | OnceOnly/Daily | String | Allowed values: OnceOnly, Daily, Weekly, Monthly | Yes |
| selectDevicesMethod | Device | String | Allowed values: Category, BV, Device, URL, GROUP | Yes |
| selectedCateg | Device category (applicable only if selectDevicesMethod is 'Category') | String | Allowed characters: A–Z, a–z, 0–9, space( ), underscore(_), dot(.), slash(/), pipe(\|), question mark(?), hyphen(-), tilde(~) | No |
| selectedBV | Business view name suffixed with '_bv' (applicable only if selectDevicesMethod is 'Business View') | String | - | No |
| selectedDevices | Device IP (comma-separated values) | String | - | No |
| selectedURL | URL Monitor name (applicable only if selectDevicesMethod is 'URLs') | String | - | No |
| selectedLogicalGroups | Devices Group name (comma-separated values) | String | Allowed characters: A–Z, a–z, all Unicode letters, 0–9, space( ), underscore(_), hyphen(-), dot(.), exclamation(!), colon(:), at(@), hash(#), dollar($), backslash(\), slash(/), single quote('), comma(,) | No |
| once_startat | Start date & time (applicable only if recurrence is 'OnceOnly') | String | Allowed characters: Digits(0–9), hyphen(-), space( ), colon(:) | No |
| once_endat | End date & time (applicable only if recurrence is 'OnceOnly') | String | Allowed characters: Digits(0–9), hyphen(-), space( ), colon(:) | No |
| startday | Start day of the week (applicable only for Daily) | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1–31, 32 | No |
| endday | End day of the week (applicable only for Daily) | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1–31, 32 | No |
| from_time | Start date & time (applicable only if recurrence is 'Daily') | String | Allowed values: 00:00–23:59 (hours 00–23, minutes 00–59) | No |
| to_time | End date & time (applicable only if recurrence is 'Daily') | String | Allowed values: 00:00–23:59 (hours 00–23, minutes 00–59) | No |
| daily_effectfrom | Downtime scheduler start date & time (applicable only if recurrence is 'Daily') | String | Allowed values: year-month-date (0000–9999 for year, 01–12 for month, 01–31 for date) | No |
| from_hrs | Start hour (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00–23 | No |
| to_hrs | End hour (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00–23 | No |
| from_mins | Start Minutes (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00–59 | No |
| to_mins | End minutes (applicable only if recurrence is 'Monthly') | Int | Allowed values: 00–59 | No |
| monthlyType | monthlyDate \| monthlyDay (applicable only if recurrence is 'Monthly') | String | Allowed values: monthlyDate, monthlyDay | No |
| weekOfMonth | Week of the month | String | Allowed values: First, Second, Third, Fourth, Last | No |
| weekday | Day of the week (applicable only if recurrence is 'Monthly' and monthlyType is 'monthlyDay') | String/Int | Allowed values: Sunday, Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, 1–31, 32 | No |
| mailID | Email id to which the report should be sent | String | Allowed characters: A–Z, a–z, 0–9, underscore(_), hyphen(-), dot(.), plus(+), single quote('), slash(/), at(@), comma(,), space( ) | No |
| tpiTool | Third Party Integration Tool | String | Allowed values: SDPOD | No |
| suppressType | Suppress type for downtime schedule | String | Allowed values: Alarm, Monitoring | No |
| timeZone | Time zone | String | Allowed characters: A–Z, a–z, 0–9, underscore(_), hyphen(-), slash(/) | No |
| stopDTS | Stop downtime Scheule. By default, it is false | Boolean | - | No |
| selectedValue | Selected values | String | Allowed characters: A–Z, a–z, 0–9, underscore(_), hyphen(-), dot(.), plus(+), single quote('), slash(/), at(@), comma(,), space( ) | No |

### Sample Response

HTTP Code: 200

```json
{ "result":{ "message": "Downtime Scheduler has been updated successfully."}}
```

### 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

## getDowntimeSchedule

Used to get the downtime scheduler details

### HTTP Method

GET

### API URL

```
http://localhost:8060/api/json/admin/getDowntimeSchedule?suppressType=Monitoring&scheduleId=1&scheduleName=DemoSchedule&_=1564738493372
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| scheduleName | Downtime scheduler name | String | Allowed characters: A-Z, a-z, 0-9, space( ), underscore(_) | Yes |
| suppressType | Suppress type for downtime schedule | String | Allowed values: Alarm, Monitoring | No |
| scheduleId | Schedule ID for Downtime schedule | Long | - | No |

### Sample Response

HTTP Code: 200

```json
{ "scheduleName": "DemoSchedule", "allTimeZones": [ { "name": "(GMT -12:00) Etc/GMT+12", "id": "Etc/GMT+12" } ], "onceonly_to_mins_sel": "00", "categoryName": [ "Server", "Router", "Switch", "Desktop", "Firewall", "DomainController", "LoadBalancer", "WANAccelerator", "Wireless", "UPS", "Printer", "Unknown", "Storage", "PDU", "UCS", "RAID", "FCSwitch", "TapeLibrary", "WirelessLANController", "WirelessAccessPoint", "IPMI", "MerakiController", "MerakiSecurity", "MerakiSwitch", "MerakiRadio", "MerakiVision", "MerakiCellularGateway", "SDN", "IoT", "SDWAN", "MerakiSensor", "Container" ], "selectedDevices": [ "10.5.5.1", "10.5.5.2" ], "once_endat": "2025-10-08", "availableDevices": [ "10.5.5.3", "10.5.5.4", "10.5.5.5", "10.5.5.6" ], "weekly_startweekdays": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "categoryDispName": [ "Server", "Router", "Switch", "Desktop", "Firewall", "DomainController", "Load Balancer", "WAN Accelerator", "Wireless", "UPS", "Printer", "Unknown", "Storage", "PDU", "UCS", "RAID", "FCSwitch", "TapeLibrary", "Wireless LAN Controller", "Wireless Access Point", "IPMI", "Meraki Controller", "Meraki Security", "Meraki Switch", "Meraki Radio", "Meraki Vision", "Meraki Cellular Gateway", "SDN", "IoT", "SDWAN", "Meraki Sensor", "Container" ], "weekly_endweekdays": [ "Sunday", "Monday", "Tuesday", "Wednesday", "Thursday", "Friday", "Saturday" ], "daily_effectfrom": "2025-10-08", "daily_to_hrs_sel": "14", "selectedCateg": "Printer", "MS_INSTANCEID": "1", "onceonly_from_hrs_sel": "12", "onceonly_from_mins_sel": "00", "serverTimeZone": "Asia/Calcutta", "selectedDisplayDevices": [ "10.5.5.1", "10.5.5.2" ], "businessviewsCount": "", "recurrence": "OnceOnly", "schedulesList": [ "DemoSuppress", "DemoSchedule" ], "manageScheduleID": 10, "scheduleDesc": "For testing purpose", "suppressType": "Monitoring", "daily_to_mins_sel": "00", "selectDevicesMethod": "Category", "daily_from_hrs_sel": "12", "once_startat": "2025-10-08", "unmanageScheduleID": 11, "daily_from_mins_sel": "00", "availableDisplayDevices": ["10.5.5.3", "10.5.5.4", "10.5.5.5", "10.5.5.6" ], "status": "Enabled", "onceonly_to_hrs_sel": "14"}
```

### 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

## setManaged

Manage or Unmanage the devices, interfaces or URL monitors that are currently added in OpManager.

### HTTP Method

POST

### API URL

```
https://localhost:8060/api/json/device/setManaged?manage=true&apiKey=***************
```

### Parameters

| Param Name | Description | Data Type | Additional Information | Is Mandatory |
|---|---|---|---|---|
| apiKey | API Key to access your OpManager server. | String | - | Yes |
| manage | Enables monitoring of devices or interfaces if manage=true, disables monitoring if manage=false | Boolean | - | Yes |
| isUrl | URL monitor | Boolean | - | No |
| isLicense | Licensed device | Boolean | - | No |
| isInterface | This parameter will take effect only when the value 'INTERFACE' is supplied to type param. Set the value for this param as 'true' if the managed entity is an interface. By default, the entity will be assumed as device, hence it is not required to pass this parameter for managing device. | Boolean | - | No |
| isMerakiUplink | Cisco Meraki uplink device | Boolean | - | No |
| isLiteView | Lite mode view | Boolean | - | No |
| name | Name of the device or interface. (Managed Entity name as seen in the URL of device/interface snapshot page OR 'deviceName' property value in the listDevices API response) | String | - | Yes |
| type | Set type as 'INTERFACE' if the managed entity is an interface. Set type as 'URL' if the managed entity is an Url monitor. | String | Allowed values: INTERFACE, URL, MerakiUplink | No |

### Sample Response

HTTP Code: 200

```json
{ "result":{ "message": "Device \"DemoDevice\" is being managed."}}
```

### 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 5 minutes