This API can be used to view the configuration details of all the monitors present in an account. The details shown include:
- Group name
- url
- Display name
- Poll interval
- Primary Location
- Secondary Locations
- Timeout
- Other settings such as locationfailures, maxfailurechecks, method, username, password, etc.
- Link to view availability report for all monitors.
- Link to view response time report for all monitors.
Sample Request
Below is a sample request for viewing the configuration details of all the monitors in an account:
http://site24x7.com/api/xml/configdetails?apikey=[APIKEY]
|
For example,
http://site24x7.com/api/xml/configdetails?apikey=f98394a9538975fe3ba18e1501e3ecb
Sample Success Response
Below is a sample success response in the XML format:
<response uri="/api/xml/configdetails" action="ConfigDetails"> <result> <response> <group name="me"> <monitor monitortype="URL" displayname="MyMonitor" url="https://isdndirect.com" pollinterval="5 mins" primarylocation="California, US" timeout="30 sec" failurechecks="0" locationfailures="3" contacts="name@domain.com" formsubmissionmethod="G"
basic-username="isdn\cne" basic-password="!293487@isdn" RT-Report="http://site24x7.com/login/status.do?execute=getRTReport¶m=s29C%2BqlYJKPVfceEqj2r3xNEuDDOBj3QobJHRY0Xr3U%3D&period=2
&urlid=2000000007003&color=%23FFFFFF" Availability-Report="http://site24x7.com/login/status.do?execute=getAvailabilityReport¶m=s29C%2BqlYJKPVfceEqj2r3xNEuDDOBj3QobJHRY0Xr3U%3D&
period=2&urlid=2000000007003&color=%23FFFFFF"/> </group> </response> </result> </response> |
Viewing the configuraiton details of all the monitors in an account may return some errors. Below is a sample error response shown when the API key provided is incorrect.
<response uri="/api/xml/configdetails">
<error>
<code>2890</code>
<message>
Specified apikey [f98394a9538975fe3ba18e1501e3ecb] is not valid.Provide a correct one.
</message>
</error>
</response> |
Uploading ....