Create a synthetic browser monitor.

POST

/browser_check

curl --request POST \
  --url https://api.siteqwality.com/browser_check \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "script": "example", "frequency": "example", "timeout_seconds": 1, "check_regions": [ "example" ], "min_healthy_regions": 1, "group_notification_ids": [ "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0" ], "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "tags": [ "example" ], "confirmation_threshold": 1, "rerun_on_failure": true, "trace_propagation": true }'

• Production

Authorizations

• bearer_auth

Request Body ^required

Media type application/json

object

name

required

string

script

required

string

frequency

required

string

timeout_seconds

integer | null format: int32

check_regions

array | null

min_healthy_regions

integer | null format: int32

group_notification_ids

Notification groups to alert. Left out or null: the account’s default group. []: notify no one.

array | null

service_id

string | null format: uuid

tags

array | null

confirmation_threshold

Consecutive failed runs (by the location quorum) before the check is DOWN, 1 to 10. Omitted or null means 1.

integer | null format: int32

rerun_on_failure

Rerun a failed run once from the same location before it counts. The rerun uses synthetic minutes. Omitted or null means off.

boolean | null

trace_propagation

boolean | null

Example ^generated

{
  "name": "example",
  "script": "example",
  "frequency": "example",
  "timeout_seconds": 1,
  "check_regions": [
    "example"
  ],
  "min_healthy_regions": 1,
  "group_notification_ids": [
    "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0"
  ],
  "service_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
  "tags": [
    "example"
  ],
  "confirmation_threshold": 1,
  "rerun_on_failure": true,
  "trace_propagation": true
}

Responses

201

Browser monitor created

400

Invalid request body

401

Missing or invalid authentication

402

Monitor limit reached for the account’s plan

403

Browser check limit reached, or multi-region without a paid plan

500

Internal server error