List Outages: list_outages

Service name: list_outages

URL

https://SERVER/api/?apikey=yourAPItoken&service=list_outages

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Returns list of outages which are either still open, or which were closed in last 61 days.

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

deviceid

The deviceid must be a valid id.

integer

yes

0

0

Example Service Call =list_outages

https://SERVER/api/?apikey=yourAPItoken&service=list_outages&deviceid=DEVICEID

Example Response - Performance Monitoring Check - Processor Queue Length (Windows)

<?xml version="1.0" ?>

<result created="2015-08-03T15:55:08+01:00" host="SERVER" status="OK">

<outage>

<reason>DEVICE_OVERDUE</reason>

<state>OPEN</state>

<utc_start>2015-02-09 09:35:04</utc_start>

<outage_id>103725102</outage_id>

</outage>

<outage>

<reason>CHECK_FAILURE</reason>

<state>OPEN</state>

<utc_start>2015-02-09 08:45:05</utc_start>

<outage_id>103723249</outage_id>

<check_id>12231188</check_id>

<check_type>1002</check_type>

<check_description>Backup Check - Backup & Recovery</check_description>

<check_status>FAILING</check_status>

<check_frequency>DAILY</check_frequency>

<cause>Backup status can not be determined</cause>

</outage>

<outage>

<reason>CHECK_FAILURE</reason>

<state>CLOSED</state>

<utc_start>2015-02-07 06:29:59</utc_start>

<utc_end>2015-02-07 06:44:27</utc_end>

<outage_id>112951120</outage_id>

<check_id>15779378</check_id>

<check_type>1024</check_type>

<check_description>Script Check - Running Process - lsm.exe</check_description>

<check_status>PASSING</check_status>

<check_frequency>24x7</check_frequency>

<cause>Script timed out</cause>

</outage>

</result>

Fields Description

Common outputs for each listed outage

Key

Description

outage_reason

CHECK_FAILURE

DEVICE_OFFLINE

DEVICE_OVERDUE

SITE_DOWN

UPLOAD_ERROR

outage_state

OPEN

CLOSED

utc_start

UTC date and time when the outage was opened

utc_end

UTC date and time when the outage was closed

In addition to the above items, outages with outage_reason=CHECK_FAILURE will have:

check_id

Unique identification number of the Check

check_type

Identification number for the check_type. A list of these check_types are available in the list_checks API call section of this guide.

check_frequency

24x7

DAILY

check_status

Current Check status

PASSING

FAILING

CLEARED

check_description

Textual description of the Check including identification information. For example: Disk Space Check - drive F:

check_extra_info

Extra information on the Check (where available).

Example Associated Service Calls
Parameter Call URL Format
DeviceID list_devices_at_client

https://SERVER/api/?apikey=yourAPItoken&service=list_devices_at_client&clientid=CLIENTID&devicetype=server

list_servers

https://SERVER/api/?apikey=yourAPItoken&service=list_servers&siteid=SITEID

list_workstations

https://SERVER/api/?apikey=yourAPItoken&service=list_workstations&siteid=SITEID

SiteID list_sites https://SERVER/api/?apikey=yourAPItoken&service=list_sites&clientid=CLIENTID
ClientID list_clients https://SERVER/api/?apikey=yourAPItoken&service=list_clients