List Outages

Base URL

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_outages

Description

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

Parameters

Required parameters

Add required parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_outages&required_parameters={parameter-value}

Parameter	Description	Type	Options	Default
deviceid	The deviceid must be a valid id.	integer	0	0

Optional parameters

Add optional parameters immediately after the base URL.

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_outages&optional_parameters={parameter-value}

Parameter	Description	Type	Required	Options	Default
describe	Returns a description of the service.	boolean	no	true	0

Determine parameter values

Use the following associated service calls to determine parameter values.

Parameter	Call	URL Format
deviceid	list_devices_at_client	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_devices_at_client&clientid=CLIENTID&devicetype=server
	list_servers	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_servers&siteid=SITEID
	list_workstations	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_workstations&siteid=SITEID
siteid	list_sites	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_sites&clientid=CLIENTID
clientid	list_clients	https://`{SERVER}`/api/?apikey=`{yourAPIkey}`&service=list_clients

Examples

List Outages

https://{SERVER}/api/?apikey={yourAPIkey}&service=list_outages&deviceid=DEVICEID

Example response

<?xml version="1.0" ?>
<result created="2024-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>

Key	Description
outage_id	The check's unique identifier.
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
check_id	Unique identification number of the Check (only for outage_reason=CHECK_FAILURE)
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)