Edit Monitor API
With the APIs given below, you can edit or modify the details of a specific monitor:
Request Parameters
The common parameters involved in these API requests are described below:
Field |
Description |
apikey |
The key generated from the Generate API Key option in the 'Admin' tab. |
displayname |
The display name for the monitor. Html encoding for special characters is required (ex: Html
encoding for & is & and " is "). |
newdisplayname |
The new display name for the monitor. Html encoding for special characters is required (ex: Html
encoding for & is & and " is "). |
host |
The host name of applications manager server. |
pollInterval |
The interval at which the server needs to be polled. The default value is 5 minutes. |
port |
The port of Applications Manager server. |
resourceid |
The unique id which can be found from AM_ManagedObject table in the database. |
Sample Request:
This example helps you to edit the display name of a service monitor in Applications Manager:
http://[Host]:[Port]/AppManager/xml/EditMonitor?apikey=[APIKEY]&type=ServiceMonitoring&resourceid=[RESOURCEID]&newdisplayname=[NEWDISPLAYNAME]&pollInterval=[pollInterval]&command=[COMMAND]&search=[SEARCH]
If the API is not executed correctly, the request will fail and errors will be thrown. Refer this page for a list of common error conditions.
Top