Default locations for a new uptime monitor.

GET

/check-locations/default

const url = 'https://api.siteqwality.com/check-locations/default?run_interval_seconds=1';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://api.siteqwality.com/check-locations/default?run_interval_seconds=1' \
  --header 'Authorization: Bearer <token>'

What a create that leaves out check_regions stores: the check type’s default location, or on an uptime plan with multi-location checks the default plus a healthy location on another provider in its country, while the account’s projected checks stay within half its quota. A type that only one provider runs in that country gets one location. The projection is returned either way.

Authorizations

bearer_auth

Parameters

Query Parameters

run_interval_seconds

required

integer format: int32

How often it runs, 60 to 86400 seconds.

run_interval_thirty_seconds

boolean | null

Runs every 30 seconds (needs run_interval_seconds 60). Default false.

monitor_tls

boolean | null

Pairs a daily TLS check, as on create. Default true for http; always false for tcp and ping.

monitor_dns

boolean | null

Pairs a daily domain check, as on create. Default true for http, false otherwise.

check_type

One of:

string
null

What an uptime monitor checks. Stored as text with a CHECK and decoded strictly.

string

Allowed values: http tcp ping

http (the default), tcp or ping: picks the locations that run that check.

Responses

200

The default locations and the projected checks

application/json

What a new HTTP monitor runs on when its create names no check_regions, and the projected usage behind the choice (GET /check-locations/default).

object

check_regions

required

The default location, or it plus a healthy location on another provider in its country.

Array<string>

min_healthy_regions

required

1: a pair alerts only when both locations fail.

integer format: int32

single_location_reason

One of:

string
null

Set when check_regions is one location; absent for the pair.

string

Allowed values: plan quota no_healthy_pair

projection

required

Projected uptime checks over 30 days. Each location result is one check.

object

checks_per_location_per_month

required

One location at this interval.

integer format: int64

paired_checks_per_month

required

The daily TLS and domain checks paired with the monitor.

integer format: int64

monitor_checks_per_month

required

The new monitor on check_regions, paired checks included.

integer format: int64

account_checks_per_month

required

The account’s active HTTP monitors before this one.

integer format: int64

quota

required

The account’s uptime quota per usage period.

integer format: int64

pair_quota_percent

required

The pair is the default only while the account stays within this percent of quota.

integer format: int64

recheck_on_failure

required

What a create without recheck_on_failure stores: another_cloud on a paid plan where another provider can run the check, same_location otherwise.

string

Allowed values: off same_location another_cloud

Example

{
  "single_location_reason": "plan",
  "recheck_on_failure": "off"
}

400

Invalid run interval

401

Missing or invalid authentication

500

Internal server error