REST APIs - Applications and Servers

Introduction

This section is common to all the editions of IT360 - Professional Edition, Enterprise Edition (Both the Central Server and the Probes) and the MSP Edition (Both the Central Server and the Probes).

ManageEngine IT360 provides REST APIs, for fetching data from the Applications and Servers module of IT360. Using these APIs, the 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, such as Java, C, Perl, 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

ManageEngine IT360 User Account:

Each ManageEngine IT360 user should have a valid UserName, to use the API.

Consider, for e.g. 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 ManageEngine IT360 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 ManageEngine IT360 product, by navigating to 'Admin -> API Integration -> REST API -> Servers & Applications'.

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

Top

Steps for using REST API

  1. Login to IT360 console with the Username and Password of an Admin user.

  2. Click the Admin tab in the header pane.

  3. Click API Integration under General.

  4. Click the REST API tab. Choose the Servers & Applications radio button. In the REST API wizard displayed, do the following:

  5. The API key is generated, as for e.g., 2f5fc17ff73dff133cd1fbcf9c3cfb55.

  6. With the generated REST API key, the following URL is used for fetching alarms from ManageEngine IT360. Open the browser and enter the below URL:

'http://[myappmanager-server]:9090/AppManager/xml/ListAlarms?apikey=[API key]&type=all'

  1. By changing '<type>' = required monitor, data pertaining to that monitor can be retrieved. Check if the following URL works fine:
    'http://[myappmanager-server]:9090/AppManager/xml/ListAlarms?apikey=[API key]&type=type'

  2. The above URL will give data of all the server monitors. 'all' will give the entire ManageEngine IT360's data.

  3. By using any xml parser in a scripting language, such as 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.

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 ManageEngine IT360 by using ResourceID ManageMonitor.xsdUnmanageMonitor.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 Allows the user to add monitors in ManageEngine IT360. 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.

Top



Copyright © 2014, ZOHO Corp. All Rights Reserved.