PUT   checks/{checkId}

Updates a check.

URL Parameters

NameDescription
checkId

Check identifier. Type: numeric.

Remarks

Thresholds

There is a set of properties (each starts with threshold_) used for thresholds definition. Read more on thresholds here.

Scheduled Inclusion/Exclusion

The scheduled_inclusion parameter defines specific day/time ranges when the check will run. Set empty string to reset the value.
The scheduled_exclusion parameter defines specific day/time ranges when the check will not run. Set empty string to reset the value.

Example: mon-fri: 05:00-24:00;sat-sun: 08:00-20:00

Syntax: PERIOD [ ; PERIOD]
where
PERIOD ::= ( WEEK-DAY-LIST | MONTH-DAY-LIST | DATE-LIST ) : TIME-RANGE
WEEK-DAY-LIST ::= WEEK-DAY-SPEC [ , WEEK-DAY-LIST ]*
WEEK-DAY-SPEC ::= ( WEEK-DAY | WEEK-DAY-RANGE )
WEEK-DAY-RANGE ::= WEEK-DAY - WEEK-DAY
WEEK-DAY ::= ( mon | tue | wed | thu | fri | sat | sun )
MONTH-DAY-LIST ::= MONTH-DAY-SPEC [ , MONTH-DAY-LIST ]*
MONTH-DAY-SPEC ::= ( MONTH-DAY | MONTH-DAY-RANGE )
MONTH-DAY-RANGE::= MONTH-DAY - MONTH-DAY
MONTH-DAY ::= 0-31 (Note: Month day 0 means last day of month)
DATE-LIST ::= DATE-SPEC [ , DATE-LIST ]*
DATE-SPEC ::= ( DATE | DATE-RANGE )
DATE-RANGE ::= DATE - DATE
DATE ::= [yy]yy-mm-dd
TIME-RANGE ::= TIME-SPEC - TIME-SPEC
TIME-SPEC ::= hh[:mm[:ss]]

Interval

The interval_seconds field defines the frequency of running check. Set interval_seconds = 0 if the check should run manually.

Request body model example and description

{
  "name": "Check name",
  "description": "Check description",
  "interval_seconds": 300,
  "max_attempts": 3,
  "threshold_w": 15000,
  "threshold_w_set_0": true,
  "threshold_w_dynamic": {
    "baseline_measure": "avg|mdn|std",
    "baseline_period_h": 2,
    "factor": 2.0,
    "offset": 0
  },
  "threshold_e": 30000,
  "threshold_e_set_0": false,
  "threshold_e_dynamic": {
    "baseline_measure": "avg|mdn|std",
    "baseline_period_h": 2,
    "factor": 2.0,
    "offset": 0
  },
  "threshold_lo_w": 5000,
  "threshold_lo_w_set_0": true,
  "threshold_lo_w_dynamic": {
    "baseline_measure": "avg|mdn|std",
    "baseline_period_h": 2,
    "factor": 2.0,
    "offset": 0
  },
  "threshold_lo_e": 10000,
  "threshold_lo_e_set_0": false,
  "threshold_lo_e_dynamic": {
    "baseline_measure": "avg|mdn|std",
    "baseline_period_h": 2,
    "factor": 2.0,
    "offset": 0
  },
  "enabled": true,
  "scheduled_inclusion": "mon-fri: 21:30-22; sun:15-17; 0-1:12-18; 2012-04-01-2012-04-30:18-23",
  "scheduled_exclusion": "mon-fri: 21:30-22; sun:15-17; 0-1:12-18; 2012-04-01-2012-04-30:18-23"
}
NameType Required Description
name String No

No documentation available.

description String No

No documentation available.

interval_seconds Integer No

No documentation available.

max_attempts Integer No

No documentation available.

threshold_w Integer No

The value of high warning threshold.

threshold_w_set_0 Boolean No

The flag indicating whether or not the high warning threshold should be set to 0.

threshold_w_dynamic Object No

The object for configuring dynamic calculation of high warning threshold.

baseline_measure String No

The baseline for calculating dynamic threshold.

baseline_period_h Integer No

The period in hours for calculation depending on the specified baseline.

factor Float No

No documentation available.

offset Integer No

No documentation available.

threshold_e Integer No

The value of high error threshold.

threshold_e_set_0 Boolean No

The flag indicating whether or not the high error threshold should be set to 0.

threshold_e_dynamic Object No

The object for configuring dynamic calculation of high error threshold.

baseline_measure String No

The baseline for calculating dynamic threshold.

baseline_period_h Integer No

The period in hours for calculation depending on the specified baseline.

factor Float No

No documentation available.

offset Integer No

No documentation available.

threshold_lo_w Integer No

The value of low warning threshold.

threshold_lo_w_set_0 Boolean No

The flag indicating whether or not the low warning threshold should be set to 0.

threshold_lo_w_dynamic Object No

The object for configuring dynamic calculation of low warning threshold.

baseline_measure String No

The baseline for calculating dynamic threshold.

baseline_period_h Integer No

The period in hours for calculation depending on the specified baseline.

factor Float No

No documentation available.

offset Integer No

No documentation available.

threshold_lo_e Integer No

The value of low error threshold.

threshold_lo_e_set_0 Boolean No

The flag indicating whether or not the low error threshold should be set to 0.

threshold_lo_e_dynamic Object No

The object for configuring dynamic calculation of low error threshold.

baseline_measure String No

The baseline for calculating dynamic threshold.

baseline_period_h Integer No

The period in hours for calculation depending on the specified baseline.

factor Float No

No documentation available.

offset Integer No

No documentation available.

enabled Boolean No

No documentation available.

scheduled_inclusion String No

No documentation available.

scheduled_exclusion String No

No documentation available.