ManageEngine® Applications Manager


Chapter 10. Applications Manager REST APIs

<< Prev

Home

Next >>

 

Applications Manager REST APIs

 

ManageEngine Applications Manager provides REST APIs for fetching data from Applications Manager. Using these APIs, Applications Manager's data can be integrated with any internal portal or 3rd party System Management software. The data can be represented in a single dashboard itself.

 

By using any XML parser in a scripting language, Java, C, Perl or Python, etc. you can make HTTPs requests in the format recommended in the API. This data can then be inserted into your own database or put in any format that you need.

 

Prerequisites

 

Applications Manager User Account

 

Each Applications Manager User should have a valid UserName to use the API.

 

Take for eg, In an Intranet Portal, if each user logs in, the assigned monitors, alarms will be shown. So, it is imperative that each user should have an API Key separately. When GetAlarms API is invoked with the key generated for that particular Operator, it will list the Alarms that are assigned to that person alone.

How the APIs work?

 

In order to use the API, each user should obtain an API key - which is a long text and is unique to their Applications Manager Account. The API key has to be passed as parameter in every API request made.

 

Generate API Key

 

The User can register for the API key from within Applications Manager product using the "REST API" option in the Admin tab.

 

Note: Getting the API Key is a one-time process.

 

 

Steps for using REST API

API Description

 

REST Command Description XSD
ListMonitor This API allows the user to know the availability, health status of monitors, type, state - managed/unmanaged, etc. ListMonitor.xsd
ListServer This API allows the user to know the details of servers like IP Address, status, services running in them, etc. ListServer.xsd
ListAlarms This API allows the user to know the details like alarm state - critical/warning/clear, type, top N alarms, time bound alarms, etc. ListAlarms.xsd
Manage / UnManage This API allows the user to Manage or UnManage a Monitor in Applications Manager by using ResourceID. ManageMonitor.xsd
UnmanageMonitor.xsd
CreateMaintenanceTask This API allows the user to create a downtime schedule. CreateMaintenanceTask.xsd
EditMaintenanceTask This API allows the user to edit a downtime schedule. EditMaintenanceTask.xsd
DeleteMaintenanceTask This API allows the user to delete a downtime schedule. DeleteMaintenanceTask.xsd
GetMonitorData/ListMonitorData This API allows the user to fetch data of the latest poll from monitors. ListMonitorData.xsd
AddMonitor This API allows the user to the user to add monitors in Applications Manager. AddMonitor.xsd
ListMaintenanceTaskDetails This API allows the user to list all the scheduled downtime. ListMaintenanceTaskDetails.xsd
AddMonitorGroup
This API allows the user to add a new Monitor Group.
AddMonitorGroup.xsd
PollNow
This API allows the user to poll a monitor.
PollNow.xsd
DeleteMonitor
This API allows the user to delete the monitor.
DeleteMonitor.xsd

 

 

Note: You can obtain the resourceid of a monitor by executing the ListMonitor API request. The output of this request contains resourceid of the monitor, among other values.

REST API xsd files are available in AppManager9/help/RESTAPI/xsd folder.

 

 

<< Prev

Home

Next >>

Production Environment


ListMonitor API