ManageEngine® Applications Manager

Get Downtime Details API

This API is used to obtain the downtime data use of a monitor or a monitor group requested by the user for a specific period of time.

API for XML Response:

http://[ APM Host ]:[ APM Port ]//AppManager/xml/GetDowntimeDetails?apikey=[API Key ]&period=6&resourceid=10000035&showFullDetails=true

API for JSON Response:

http://[ APM Host ]:[ APM Port ]/AppManager/json/GetDowntimeDetails?apikey=[API Key ]&period=6&resourceid=10000035&showFullDetails=true

Request Parameters:

Field	Description
apikey	The key generated using the Generate API Key option in the 'Admin' tab.
resourceid	The resource id of the monitor, using which you can ping the host corresponding to the monitor.
period	The host of any server which can be passed as a parameter to ping from the Applications Manager server.
showFullDetails	An optional parameter used to specify if user needs downtime details on a daily basis as additional data in response. Values are true or false (false dy default).

XML Input

http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails?apikey=c4e547c2330e2eb92d3e7af2362da9e9&period=6&resourceid=10000135&showFullDetails=true

XML Response

<AppManager-response uri="/AppManager/xml/GetDowntimeDetails">

</Downtimes>

</result>

</AppManager-response>

JSON Input

http://apm-prod1:9090/AppManager/xml/GetDowntimeDetails?apikey=c4e547c2330e2eb92d3e7af2362da9e9&period=6&resourceid=10000135&showFullDetails=true

JSON Response

{"response":{"result":[{"AvailabilityMessage":"-","SchedulePercent":"0.0","DisplayName":"LocalFile","ResourceId":"10000155","UnmanagePercent":"0.0","AvailabilitySeverity":"-","DownPercent":"100.0","Downtimes":[{"Date":"August 22, 2013","DownPercent":"100.0","SchedulePercent":"0.0","UpPercent":"0.0","UnmanagePercent":"0.0","DowntimeSummary":[{"DownTimeMillis":"1377109801322","UpTime":"11:59:59 PM","DownTime":"12:00:01 AM","Downtime_Reason":"No Information Available.","TotalDownTime":"23 Hrs 59 Mins 58 Secs","ReasonID":"-1"}]},{"Date":"August 21, 2013","DownPercent":"54.88","SchedulePercent":"0.0","UpPercent":"45.12","UnmanagePercent":"0.0","DowntimeSummary":[{"DownTimeMillis":"1377062383743","UpTime":"11:59:59 PM","DownTime":"10:49:44 AM","Downtime_Reason":"No Information Available.","TotalDownTime":"13 Hrs 10 Mins 16 Secs","ReasonID":"-1"}]},{"Date":"August 20, 2013","DownPercent":"0.0","SchedulePercent":"0.0","UpPercent":"100.0","UnmanagePercent":"0.0","DowntimeSummary":[]},{"Date":"August 19, 2013","DownPercent":"0.0","SchedulePercent":"0.0","UpPercent":"100.0","UnmanagePercent":"0.0","DowntimeSummary":[]}],"UpPercent":"2.8367646E-4","Period":"6"}],"uri":"/AppManager/json/GetDowntimeDetails"},"response-code":"4000"}

Response Parameters:

Field

Description

AvailabilityMessage

The current availability RCA message of the resource.

SchedulePercent

The total scheduled downtime percentage of the resource.

DisplayName

The display name of the resource.

ResourceId

The resource id of the monitor, using which you can ping the host corresponding to the monitor.

UnmanagePercent

The total unmanaged downtime percentage of the resource.

AvailabilitySeverity

The current availability severity of the resource.

DownPercent

The total downtime percentage of the resource.

UpPercent

The total uptime percentage of the resource.

Period

The period for which the downtime details have been requested:
Period : 0 ===> Today
Period : 3 ===> Yesterday
Period : 6 ===> This Week
Period : 1 ===> Last 7 days
Period : 12 ===> Last Week
Period : 7 ===> This Month
Period : 2 ===> Last 30 days
Period : 11 ===> Last Month
Period : 9 ===> This Quarter

Period : 8 ===> This Year
Period : 5 ===> Last 1 year
Period : 4 ===> -- Custom Period -- (Not Supported now)

Downtimes ( displayed only when requested for FullDetails)

Field

Description

Date

Represents the date for which the below details are calculated

DownPercent

Downtime percentage on above for the above date field

SchedulePercent

Scheduled downtime percentage on above for the above date field

UpPercent

Availability percentage on above for the above date field

UnmanagePercent

Unmanaged percentage on above for the above date field

DowntimeSummary
(Appears only if there is a downtime on that date)

Field	Description
DownTimeMillis	Total Downtime in Milliseconds ex: 1342381696674
UpTime	Formatted Time at which the resource went up after being down for some period. ex: 3:28:42 PM
DownTime	Formatted Time at which the resource went down. ex: 1:18:17 AM
TotalDownTime	Total downtime in Hrs,mins and sec ex: 14 Hrs 10 Mins 25 Secs
ReasonID	Reason Id for the Below mentioned Downtime Reason. (-1 if no information is available for downtime)
Downtime_Reason	Reason for downtime occured. ex: Outage is due to power supply. No Information Available. : if no reason is mentioned

<< Prev	Home	Next >>
List Data APIs		Get Monitor Data API