|
ManageEngine® Applications Manager 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.
Applications Manager User Account
Each Applications Manager User should have a valid UserName to use the API.
Take an intranet portal for example. When each user logs in, the
assigned monitors and alarms will be shown. So, it is imperative that each
user should have separate API keys. 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.
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.
The User can register for the API key from within Applications Manager product using the "REST API" option in the Admin tab.
| Note: Generating the API key is a one-time process. |
Click on the Admin tab
Under Applications Manager Server Settings, click on REST API.
The API key is generated - eg.7b5fde68148fa2419bc2f1a1ab87e757
Open the browser, the URL would be
http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=all
By changing <type> to the required monitor, data
pertaining to that monitor can be retrieved. Check if the following URL
works fine
http://<myappmanager-server>:9090/AppManager/xml/ListServer?apikey=7b5fde68148fa2419bc2f1a1ab87e757&type=server
will give data of all the server monitors. 'all' will give the entire Applications Manager's data.
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.
| 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 |
||
| Authenticator | This API allows the user to get the REST-API key with the username and password., will work only with (https) | Authenticator.xsd | ||
| ListDashboards | This API allows the user to list all the dashboards configured in the Applications Manager. | ListDashboards.xsd | ||
| ListMonitorTypes | This API allows the user to list all the configured monitor types and their details. | ListMonitorTypes.xsd | ||
| ListMonitorGroups | This API allows the user to list all the monitor groups and their basic details. | ListMonitorGroups.xsd | ||
| ListMGDetails | This API allows the user to fetch the details about a monitor group like Associated monitors, subgroups etc. | ListMGDetails.xsd | ||
| ListActions | This API allows the user to fetch the list of actions configured for the monitors. | ListActions.xsd | ||
| ExecuteAction | This API allows the user to execute a particular action. | ExecuteAction.xsd | ||
| Search | This API allows the user to get the list of monitors matching the search term. | Search.xsd | ||
| ShowPolledData | This API allows the user to fetch the polled data or archived data based on the request parameter 'period' | ShowPolledData.xsd | ||
| Ping | This API allows the user to ping the monitor or host from the applications manager server. | Ping.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 AppManager11/help/RESTAPI/xsd folder. |
Production Environment |
AddMonitor API |