ManageEngine Applications Manager provides the List Server API, which enables users to retrieve information about servers and the services running on them (such as PostgreSQL, Tomcat, MSSQL, etc.). The API supports fetching server details in the following ways:
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/ListServer?apikey=[ API Key ]&type=all
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/ListServer?apikey=[ API Key ]&type=all
Note: When type=all is specified, the API returns only authenticated servers, along with the details of the services running on those servers.
Supported HTTP methods: GET
Allowed roles: Administrator, Operator, User
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/ListServer?apikey=[ API Key ]&type=[ Server ParentNode Name ]
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/ListServer?apikey=[ API Key ]&type=[ Server ParentNode Name ]
Supported HTTP methods: GET
Allowed roles: Administrator, Operator, User
API for XML Response:
https://[HOST]:[PORT]/AppManager/xml/ListServer?apikey=[ API Key ]&ipaddress=[ IP Address of server ]
API for JSON Response:
https://[HOST]:[PORT]/AppManager/json/ListServer?apikey=[ API Key ]&ipaddress=[ IP Address of server ]
Supported HTTP methods: GET
Allowed roles: Administrator, Operator, User
| Field | Description |
|---|---|
| apikey | The key generated from "Generate API " option in the Settings tab. |
| type | Indicates the type of server details that are to be listed. Possible values are:
|
| ipaddress | IP address of the server. |
https://apm-prod-server:8443/AppManager/xml/ListServer?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=all
https://apm-prod-server:8443/AppManager/xml/ListServer?apikey=aaaaaabbbbbbccccccddddddeeeeee&type=app-windows
https://apm-prod-server:8443/AppManager/xml/ListServer?apikey=aaaaaabbbbbbccccccddddddeeeeee&ipaddress=192.123.4.5
| Parameter | Description |
|---|---|
| Name | Name of the Server |
| Parent IP | Parent Network IP address of the Server |
| resourceid | Resource ID of the Server |
| Type | Server Type like Windows |
| DISPLAYNAME | Display Name of the Server like XP1 |
| IPADDRESS | IP Address of the Server |
| Service Details | Contains information about the services running in the server.
|
| RCALink | Link to Root Cause Analysis details |
| DetailsPageLink | Link to the Details page of the Server |
<AppManager-response uri="/AppManager/xml/ListServer">
<result>
<response response-code="4000">
<Server DISPLAYNAME="pavankumar-0549" RESOURCEID="10000038" Name="pavankumar-0549.csez.zohocorpin.com" PARENTIP="10.0.0.0" IPADDRESS="192.168.24.211" TYPE="Windows 7">
<Service ATTRIBUTEID="2100" RESOURCEID="10000043" DISPLAYNAME="pavankumar-0549_Apache Server_9090" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-0549.csez.zohocorpin.com_Apache-server_9090" DetailsPageLink="/showresource.do?resourceid=10000043&method=showResourceForResourceID" RCALink="/jsp/RCA.jsp?resourceid=10000043&attributeid=2100" TYPE="Apache"/>
<Service ATTRIBUTEID="152" RESOURCEID="10000044" DISPLAYNAME="pavankumar-0549-9090" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-0549.csez.zohocorpin.com_Port-Test_9090" DetailsPageLink="/showresource.do?resourceid=10000044&method=showResourceForResourceID" RCALink="/jsp/RCA.jsp?resourceid=10000044&attributeid=152" TYPE="Service Monitoring"/>
<Service ATTRIBUTEID="15" RESOURCEID="10000055" DISPLAYNAME="pavankumar-0549_Tomcat Server_9090" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-0549.csez.zohocorpin.com_Tomcat-server_9090" DetailsPageLink="/showresource.do?resourceid=10000055&method=showResourceForResourceID" RCALink="/jsp/RCA.jsp?resourceid=10000055&attributeid=15" TYPE="Tomcat"/>
<Service ATTRIBUTEID="2000" RESOURCEID="10000149" DISPLAYNAME="pavankumar-0549" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-0549.csez.zohocorpin.com_IIS-server_80" DetailsPageLink="/showresource.do?resourceid=10000149&method=showResourceForResourceID" RCALink="/jsp/RCA.jsp?resourceid=10000149&attributeid=2000" TYPE="IIS"/>
<Service ATTRIBUTEID="3301" RESOURCEID="10000154" DISPLAYNAME="pavankumar-0549 dot net" DESCRIPTION="Network Resource" RESOURCENAME="IF-pavankumar-0549.csez.zohocorpin.com_.NET" DetailsPageLink="/showresource.do?resourceid=10000154&method=showResourceForResourceID" RCALink="/jsp/RCA.jsp?resourceid=10000154&attributeid=3301" TYPE=".NET"/>
</Server>
</response>
</result>
</AppManager-response>
Thank you for your feedback!
