Remote Monitoring & Management Help

Clear a Check: clear_check

Service name: clear_check

URL

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

&required_parameters=required_parameters

[&optional_parameters=optional_parameters]

Description

Clear a check status. After a check has failed, mark it as 'cleared', thereby acknowledging the cause of the failure.The check will be shown using an amber tick. A note describes the reason for the failure and the action taken by the engineer.

This API call is only supported where Check Clearing is enabled on the account for this check frequency type, i.e. 24x7 and/or Daily Safety Check.

Only Checks that are currently in the failing state (red exclamation box on the Dashboard) can be cleared.

Dashboard Notes

Where the option to Prompt for notes when clearing failed checks is enabled in Settings > General Settings> Notes, both the public

note (customer facing) and the private note (for engineers) must be non-empty.

For example:

https://SERVER/api/?apikey=yourAPItoken&service=clear_check&checkid=X&public_note=Public%20Note&private_note=Private%20Note

Any Check clearing action adds an entry in the User Audit Report.

Parameters

Post Variable

Description

Type

Required

Options

Default

describe

Optional. Returns a description of the service.

boolean

no

true

0

checkid

The ID of the Check you want to clear.

number

yes

0

0

private_note

Technical (private) note

string

no

0

0

public_note

Client facing note

string

no

0

0

clear_type

Optional. Action taken on clearing check untilpasses, untilnextrun, or untildatetime*.

Reverts to default if not provided.

string

no

untilpasses untilnextrun untildatetime

0

clear_until

Optional. *If untildatetime is selected as the clear_type then this date/time value is required to determine how long a check will be cleared until.

Format is ISO-8601, e.g. 2013-10-21 11:22:33

datetime

no

0

0

Example Service Call =clear_check

https://SERVER/api/?apikey=yourAPItoken&service=clear_check&checkid=CHECKID&clear_type=untildatetime&clear_until=CLEAR_UNTIL

Example Response

<?xml version="1.0" ?>

<result created="2011-03-25T16:20:24+00:00" host="SERVER" status="OK">

 <message><![CDATA[check cleared]]></message>

</result>

Fields Description

Field

Type

Can Be Empty

Description

message

string

no

Message relating to clear check state