POST   checks/browser

Creates a new browser check.

Remarks

Use GET checks/browser/locations route to get the list of values applicable for location_code.
Use GET groups route to get sub-groups ids applicable monitor_groups_ids.

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. If no value specified (or null) it means 'always'.
The scheduled_exclusion parameter defines specific day/time ranges when the check will not run. If no value specified (or null) it means 'none'.

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. If no value specified (or null), the check will run with default interval. Set interval_seconds = 0 if the check should run manually.

Returns HTTP 201 when created (the Location header must contain URL to the new check).

Request body model example and description

{
  "url": "sample string 1",
  "name": "sample string 2",
  "description": "sample string 3",
  "monitor_groups_ids": [
    1,
    2,
    3
  ],
  "interval_seconds": 1,
  "max_attempts": 1,
  "location_code": "sample string 4",
  "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": 25000,
  "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
  },
  "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
url String Yes

No documentation available.

name String Yes

No documentation available.

description String No

No documentation available.

monitor_groups_ids Array No

No documentation available.

interval_seconds Integer No

No documentation available.

max_attempts Integer No

No documentation available.

location_code String Yes

No documentation available.

threshold_w Integer No

The value of high warning threshold. If not specified then no 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. If not specified then no dynamic calculation.

baseline_measure String Yes

The baseline for calculating dynamic threshold.

baseline_period_h Integer Yes

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

factor Float Yes

No documentation available.

offset Integer No

No documentation available.

threshold_e Integer No

The value of high error threshold. If not specified then no 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. If not specified then no dynamic calculation.

baseline_measure String Yes

The baseline for calculating dynamic threshold.

baseline_period_h Integer Yes

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

factor Float Yes

No documentation available.

offset Integer No

No documentation available.

threshold_lo_w Integer No

The value of low warning threshold. If not specified then no 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. If not specified then no dynamic calculation.

baseline_measure String Yes

The baseline for calculating dynamic threshold.

baseline_period_h Integer Yes

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

factor Float Yes

No documentation available.

offset Integer No

No documentation available.

threshold_lo_e Integer No

The value of low error threshold. If not specified then no 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. If not specified then no dynamic calculation.

baseline_measure String Yes

The baseline for calculating dynamic threshold.

baseline_period_h Integer Yes

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

factor Float Yes

No documentation available.

offset Integer No

No documentation available.

scheduled_inclusion String No

No documentation available.

scheduled_exclusion String No

No documentation available.