PUT   checks/proxysniffer/{checkId}

Updates a ZebraTester 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 and scheduled_exclusion parameters define specific day/time ranges when the check will run or not run respectively.
Set empty string to reset the value. Read more on the schedule syntax here.

Interval

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

Request example and description

curl --request PUT "https://api-asm1.apica.io/v3/checks/proxysniffer/12345?auth_ticket=C471ADC4-19B4-4219-BBF4-671A97EC653E" --header "Content-Type: application/json" --data-raw "{
  \"scenario_filename\": \"sample string 1\",
  \"scenario_file_type\": \"sample string 2\",
  \"concurrent_users\": 1,
  \"test_duration\": 60,
  \"request_timeout\": 60,
  \"startup_delay\": 200,
  \"max_loops\": 1,
  \"statistics_sampling_interval\": 10,
  \"max_error_snapshot\": 1,
  \"percurlopt\": 1,
  \"additional_options\": \"-nores\",
  \"unit\": \"ms\",
  \"location_code\": \"b8dce6d7-2222-1111-92e9-4a98eb706b13|europe.northern-europe.se.na.stockholm.ipv6-aaaaa|chromium|87\",
  \"secondary_location_codes\": null,
  \"fail_over\": true,
  \"name\": \"Check name\",
  \"description\": \"Check description\",
  \"interval_seconds\": 300,
  \"max_attempts\": 3,
  \"attempt_pause\": 30000,
  \"check_fail_severity\": \"F\",
  \"threshold_w\": 15000,
  \"threshold_w_set_0\": true,
  \"threshold_w_dynamic\": {
    \"baseline_measure\": \"std\",
    \"baseline_period_h\": 2,
    \"factor\": 2.0,
    \"offset\": 0
  },
  \"threshold_e\": 30000,
  \"threshold_e_set_0\": false,
  \"threshold_e_dynamic\": {
    \"baseline_measure\": \"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\": \"mdn\",
    \"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\": \"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\",
  \"tags\": [
    1,
    2,
    3
  ],
  \"target_sla\": 0.9,
  \"target_sla_2\": 0.9,
  \"verify_ping\": \"fast.com\"
}"
NameType Required Description
scenario_filename String No

Scenario class name (by default and when 'scenario_file_type' value set to 'class') or scenario original filename (when 'scenario_file_type' value set to 'original').
scenario_file_type String No

Available values: 'class', 'original'. It determines how the scenario will be defined by class name or filename. If this field is not defined then 'class' used by default.
concurrent_users Integer No

Available values: 1, 2, 3, 5, 10, 15, 20.
test_duration Integer No

Seconds. Available values: 15, 30, 45, 60, 120, 180, 300, 360.
request_timeout Integer No

Seconds. Available values: 10, 20, 30, 40, 50, 60, 120.
startup_delay Integer No

Milliseconds. Available values: 1, 2, 3, 5, 10, 20, 30, 50, 100, 200.
max_loops Integer No

Available values: 0, 1, 2, 3, 5, 10, 20, 40. 0 means unlimited.
statistics_sampling_interval Integer No

Seconds. Available values: 10, 15, 30, 60, 120, 180, 240, 300.
max_error_snapshot Integer No

Maximum number of statistic error snapshots per URL (Advanced Usage). Available values: 1, 2, 3.
percurlopt Integer No

0 = No extra URL data. 1 = Extra performance data per individual request. 2 = Store Request Headers. 5 = Store Response Headers. 7 = Store both Request & Response headers.
additional_options String No

Additional options.
unit String No

The unit of measure for the check result.
location_code String No

The check run location.
secondary_location_codes Array No

Currently not supported.
fail_over Boolean No

With Failover enabled the check will be executed on a second location if the result is not OK (Information). Only one attempt will be made from the failover location.
name String No

The name of the check.
description String No

The check description.
interval_seconds Integer No

The check run interval in seconds.
max_attempts Integer No

The max number of attempts that can be made to verify the results. This setting applies to the primary location only, not any failover locations. Available values: from 1 to 5.
attempt_pause Integer No

Between every attempt there will be an Attempt Pause before the next attempt is performed. Milliseconds. Available values : 0, 50, 100, 200, 500, 1000, 2000, 3000, 5000, 10000, 20000, 30000, 60000.
check_fail_severity String No

This will be the Severity that the check will get if it fails. This can be used to trigger a different Severity (and at the end, different alerts). I - Information, W - Warning, E - Error, F - Fatal. Default is F.
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. Available values: 'avg', 'mdn', 'std'.
baseline_period_h Integer No

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

The percentage of the average/median return value or standard deviation of the return value.
offset Integer No

The period's offset in hours.
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. Available values: 'avg', 'mdn', 'std'.
baseline_period_h Integer No

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

The percentage of the average/median return value or standard deviation of the return value.
offset Integer No

The period's offset in hours.
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. Available values: 'avg', 'mdn', 'std'.
baseline_period_h Integer No

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

The percentage of the average/median return value or standard deviation of the return value.
offset Integer No

The period's offset in hours.
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. Available values: 'avg', 'mdn', 'std'.
baseline_period_h Integer No

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

The percentage of the average/median return value or standard deviation of the return value.
offset Integer No

The period's offset in hours.
enabled Boolean No

The check enabling status.
scheduled_inclusion String No

Inclusion Periods (Default: always).
scheduled_exclusion String No

Exclusion Periods (Default: none).
tags Array No

List of tag IDs.
target_sla Float No

Sets a 1st Target SLA in percentage e.g. 99.5 or 99. This is used in certain types reports. Set 0 to reset the value.
target_sla_2 Float No

Sets a 2nd Target SLA in percentage e.g. 99.5 or 99. This is used in certain types reports. Set 0 to reset the value.
verify_ping String No

After a failed result, verify connection against this hostname with a ping request.