From db943245755206efb27d7120c11144742b333cce Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 13 May 2026 16:19:45 +0200 Subject: [PATCH 01/13] docs: document PWCS cancellation feature [RED-511] - New concepts/cancellation.mdx covering cancellation surfaces, post-cancel flow, and API versioning - New api-reference/cancel/cancel-a-session.mdx for POST /v1/cancel - New v2 check-session reference pages (trigger, retrieve, await completion) - Sidebar entries in docs.json for the above - Cross-links from concepts/results.mdx, communicate/alerts/configuration.mdx - Ctrl+C cancellation sections in cli/checkly-{pw-test,test,trigger,deploy}.mdx Co-Authored-By: Claude Opus 4.7 (1M context) --- api-reference/cancel/cancel-a-session.mdx | 5 + ...t-the-completion-of-a-check-session-v2.mdx | 3 + .../retrieve-a-check-session-v2.mdx | 3 + .../trigger-a-new-check-session-v2.mdx | 3 + cli/checkly-deploy.mdx | 9 ++ cli/checkly-pw-test.mdx | 9 ++ cli/checkly-test.mdx | 9 ++ cli/checkly-trigger.mdx | 9 ++ communicate/alerts/configuration.mdx | 6 +- concepts/cancellation.mdx | 99 +++++++++++++++++++ concepts/results.mdx | 4 + docs.json | 12 ++- 12 files changed, 169 insertions(+), 2 deletions(-) create mode 100644 api-reference/cancel/cancel-a-session.mdx create mode 100644 api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx create mode 100644 api-reference/check-sessions/retrieve-a-check-session-v2.mdx create mode 100644 api-reference/check-sessions/trigger-a-new-check-session-v2.mdx create mode 100644 concepts/cancellation.mdx diff --git a/api-reference/cancel/cancel-a-session.mdx b/api-reference/cancel/cancel-a-session.mdx new file mode 100644 index 00000000..4a28cd12 --- /dev/null +++ b/api-reference/cancel/cancel-a-session.mdx @@ -0,0 +1,5 @@ +--- +openapi: post /v1/cancel +title: Cancel a check or test session +sidebarTitle: Cancel a session +--- diff --git a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx new file mode 100644 index 00000000..d24029a8 --- /dev/null +++ b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/check-sessions/{checkSessionId}/completion +--- diff --git a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx new file mode 100644 index 00000000..10ee5c0d --- /dev/null +++ b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx @@ -0,0 +1,3 @@ +--- +openapi: get /v2/check-sessions/{checkSessionId} +--- diff --git a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx new file mode 100644 index 00000000..72deac5a --- /dev/null +++ b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx @@ -0,0 +1,3 @@ +--- +openapi: post /v2/check-sessions/trigger +--- diff --git a/cli/checkly-deploy.mdx b/cli/checkly-deploy.mdx index 1ad5c0cf..f8b30777 100644 --- a/cli/checkly-deploy.mdx +++ b/cli/checkly-deploy.mdx @@ -178,6 +178,15 @@ The Checkly CLI evaluates Git information from your local or CI environment on a +## Cancelling a deploy + +{/* TODO: confirm CLI version that ships deploy Ctrl+C handling and fill in the Note below. */} +Available in CLI vX.X+. + +`checkly deploy` may run [Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview) as part of post-deploy verification. Pressing Ctrl+C during that phase prompts you to either **cancel** the recorded check session or **detach** and let it finish in the background. Detach is the default. + +See [Cancellation](/concepts/cancellation) for the full flow. + ## Related Commands - [`checkly login`](/cli/checkly-login) - Log in to your Checkly account diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index 53c97251..80e4f723 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -432,6 +432,15 @@ npx checkly pw-test -- test.spec.ts - Test sessions are recorded by default with full logs, traces, and videos - View all artifacts in Checkly's UI +## Cancelling a run + +{/* TODO: confirm CLI version that ships pw-test Ctrl+C handling and fill in the Note below. */} +Available in CLI vX.X+. + +Press Ctrl+C during a `checkly pw-test` run to cancel the test session. The CLI sends a cancel request and waits for the runner to stop. Pressing Ctrl+C a second time exits the CLI without waiting. + +See [Cancellation](/concepts/cancellation) for the full flow. + ## Related Commands - [`checkly test`](/cli/checkly-test) - Test your setup before deployment diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index 6c14729a..b6b9640f 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -380,6 +380,15 @@ Specify [environment variables](/cli/environment-variables) to dry run checks wi npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD=doremiabc123 ``` +## Cancelling a run + +{/* TODO: confirm CLI version that ships test Ctrl+C handling and fill in the Note below. */} +Available in CLI vX.X+. + +When you started the run with `--record`, pressing Ctrl+C prompts you to either **cancel** the recorded test session in Checkly or **detach** and let it finish in the background. Detach is the default. Cancellation only applies to Playwright Check Suite runs inside the session. + +See [Cancellation](/concepts/cancellation) for the full flow. + ## Related Commands - [`checkly pw-test`](/cli/checkly-pw-test) - Run Playwright tests in the Checkly cloud diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 9b0e4fd0..20ef811b 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -372,6 +372,15 @@ npx checkly trigger --tags staging --record --test-session-name "Pre-prod valida If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration. +## Cancelling a run + +{/* TODO: confirm CLI version that ships trigger Ctrl+C handling and fill in the Note below. */} +Available in CLI vX.X+. + +When you started the run with `--record`, pressing Ctrl+C prompts you to either **cancel** the recorded test session in Checkly or **detach** and let it finish in the background. Detach is the default. Cancellation only applies to Playwright Check Suite runs inside the session. + +See [Cancellation](/concepts/cancellation) for the full flow. + ## Related Commands - [`checkly deploy`](/cli/checkly-deploy) - Deploy your Checkly configuration diff --git a/communicate/alerts/configuration.mdx b/communicate/alerts/configuration.mdx index d80d81c8..09cba830 100644 --- a/communicate/alerts/configuration.mdx +++ b/communicate/alerts/configuration.mdx @@ -44,6 +44,10 @@ Understanding how settings cascade through the hierarchy: + +Runs you [cancel](/concepts/cancellation) never trigger alerts. No failure, degraded, or recovery notification is sent for a cancelled run, regardless of the settings above. + + ## Alert Configuration ### Account-Level @@ -70,7 +74,7 @@ Configure alerts for teams and service categories: ![Group-level alert settings](/images/docs/images/alerting/alert-settings-group.png) -#### Group Override +### Group Override Configure how group settings interact with individual checks: **If checked, Group settings override individual check settings** diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx new file mode 100644 index 00000000..340416a8 --- /dev/null +++ b/concepts/cancellation.mdx @@ -0,0 +1,99 @@ +--- +title: 'Cancellation' +description: 'Stop in-flight Playwright Check Suite runs from the UI, API, or CLI. Other check types cannot be cancelled.' +sidebarTitle: 'Cancellation' +--- + +Cancellation lets you stop an in-progress [Playwright Check Suite](/detect/synthetic-monitoring/playwright-checks/overview) run. Cancelled results are flagged with `isCancelled: true`, do not trigger alerts, and are excluded from availability and performance metrics. A session that contains at least one cancelled run ends in a terminal `CANCELLED` status. + +## What you can cancel + +You can cancel two kinds of sessions, and the behaviour differs: + +**Check sessions** — created by the UI "Schedule now" button and `checkly deploy`. A check session is one execution of a single Playwright Check Suite, fanned out across the locations you configured. Cancelling the session stops every in-progress run; cancelling a single run leaves the rest of the session going. + +**Test sessions** — created by `checkly test`, `checkly trigger`, and `checkly pw-test`. A test session can contain multiple checks of different types. Cancelling the test session stops only the Playwright Check Suite runs inside it; any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs in the same session continue until they finish normally. You can also cancel a single Playwright run within the session. + + +**Only Playwright Check Suite runs are cancellable.** Other check types cannot be cancelled, even when they appear inside a test session alongside Playwright runs. Scheduled runs are also excluded; cancellation is for user-initiated runs only. + + +## How to cancel + + + +On a check session or test session page, click **Cancel session** in the header to stop the whole session. To stop just a single run, use the cancel button on its row. + + + +Send a `POST` request to [`/v1/cancel`](/api-reference/cancel/cancel-a-session) with either a `checkSessionId` or a `testSessionId`. Pass an optional `sequenceId` (or array) to cancel only specific runs within the session. + +```bash Cancel a whole check session +curl -X POST https://api.checklyhq.com/v1/cancel \ + -H "Authorization: Bearer $CHECKLY_API_KEY" \ + -H "X-Checkly-Account: $CHECKLY_ACCOUNT_ID" \ + -H "Content-Type: application/json" \ + -d '{"checkSessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}' +``` + +```bash Cancel specific runs in a test session +curl -X POST https://api.checklyhq.com/v1/cancel \ + -H "Authorization: Bearer $CHECKLY_API_KEY" \ + -H "X-Checkly-Account: $CHECKLY_ACCOUNT_ID" \ + -H "Content-Type: application/json" \ + -d '{"testSessionId": "a1b2c3d4-...", "sequenceId": ["b2c3d4e5-..."]}' +``` + + + +Press Ctrl+C during `checkly pw-test`, `checkly test`, `checkly trigger`, or `checkly deploy`. The CLI prompts you to either cancel the running session or detach (let it finish in the background). + +See the [CLI reference](/cli/overview) for command-specific behavior. + + + +## What happens after a run is cancelled + + + +The runner receives the cancellation signal, aborts the in-flight Playwright run, and reports the result back to Checkly. + + + +Each cancelled run's result has `isCancelled: true`. Once the session has stopped (any remaining non-Playwright checks finish normally), the session's status becomes `CANCELLED` because at least one of its runs was cancelled. + + + +Cancelled runs never produce failure or recovery alerts, regardless of your alert settings. See [Alert configuration](/communicate/alerts/configuration). + + + +Availability, response time percentiles, and success ratios exclude cancelled runs. Your check status does not change. Public and private dashboards omit cancelled runs from their summary counts. + + + +Because no alert is sent and the check status does not change, [automated incidents](/communicate/incidents/overview) are not opened from a cancelled run. + + + +## API versioning + +Cancellation introduces two API additions: a new `CANCELLED` value on the check-session status enum, and a new `isCancelled` boolean on individual check results. The status enum change is breaking for clients that switch on status values exhaustively, so it's only exposed through the v2 check-session endpoints; v1 clients continue to work unchanged. The `isCancelled` flag is additive and ships on the existing check-result endpoints without a version bump. + + +[`POST /v1/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session), [`GET /v1/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session), and [`GET /v1/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session) never return `CANCELLED` in `status` and do not include `isCancelled` on per-result objects. + + + +[`POST /v2/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session-v2), [`GET /v2/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session-v2), and [`GET /v2/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session-v2) return `CANCELLED` in `status` and include `isCancelled` on each per-result object. + + + +[`GET /v1/check-results/{checkId}/{checkResultId}`](/api-reference/check-results/retrieve-a-check-result) and the list endpoints include `isCancelled` on every result. + + + +[`POST /v1/cancel`](/api-reference/cancel/cancel-a-session) is the action endpoint itself. It accepts either a `checkSessionId` or a `testSessionId` in the body, so a single endpoint covers both. + + +If you build automation against check sessions and want to handle cancelled runs explicitly, switch to the v2 endpoints. diff --git a/concepts/results.mdx b/concepts/results.mdx index 8e07ea57..e868bacc 100644 --- a/concepts/results.mdx +++ b/concepts/results.mdx @@ -10,6 +10,10 @@ Each time a Check executes—whether it's testing an API endpoint, clicking thro **Results** are more than just pass or fail indicators. They're comprehensive records that include performance metrics, error details, screenshots, network traces, and any other telemetry that helps you understand not just whether something worked, but how well it worked and why it might have failed. + +Playwright Check Suite runs can also be [cancelled](/concepts/cancellation) while they are in progress. Cancelled results are excluded from availability and performance metrics. + + ## Understanding Result Data You can select any check on the main Checkly dashboard to get an overview of the results they have produced so far. diff --git a/docs.json b/docs.json index 8d54a130..f9a8994e 100644 --- a/docs.json +++ b/docs.json @@ -68,6 +68,7 @@ "concepts/locations", "concepts/scheduling", "concepts/results", + "concepts/cancellation", "concepts/metrics" ] }, @@ -726,8 +727,17 @@ "group": "Check Sessions", "pages": [ "api-reference/check-sessions/trigger-a-new-check-session", + "api-reference/check-sessions/trigger-a-new-check-session-v2", "api-reference/check-sessions/retrieve-a-check-session", - "api-reference/check-sessions/await-the-completion-of-a-check-session" + "api-reference/check-sessions/retrieve-a-check-session-v2", + "api-reference/check-sessions/await-the-completion-of-a-check-session", + "api-reference/check-sessions/await-the-completion-of-a-check-session-v2" + ] + }, + { + "group": "Cancel", + "pages": [ + "api-reference/cancel/cancel-a-session" ] }, { From 82da71986f82b2d4576caa67037d38dd8f9f3920 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 13 May 2026 16:31:25 +0200 Subject: [PATCH 02/13] docs: mark v1 check-session endpoints as deprecated Match the convention used by check-groups and check-results: v1 MDX pages get deprecated: true when a v2 equivalent exists. Updates the matching ResponseField label in concepts/cancellation.mdx from backwards-compatible to deprecated for consistency. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../check-sessions/await-the-completion-of-a-check-session.mdx | 3 ++- api-reference/check-sessions/retrieve-a-check-session.mdx | 3 ++- api-reference/check-sessions/trigger-a-new-check-session.mdx | 3 ++- concepts/cancellation.mdx | 2 +- 4 files changed, 7 insertions(+), 4 deletions(-) diff --git a/api-reference/check-sessions/await-the-completion-of-a-check-session.mdx b/api-reference/check-sessions/await-the-completion-of-a-check-session.mdx index 6e93205c..3c14b799 100644 --- a/api-reference/check-sessions/await-the-completion-of-a-check-session.mdx +++ b/api-reference/check-sessions/await-the-completion-of-a-check-session.mdx @@ -1,3 +1,4 @@ --- openapi: get /v1/check-sessions/{checkSessionId}/completion ---- \ No newline at end of file +deprecated: true +--- diff --git a/api-reference/check-sessions/retrieve-a-check-session.mdx b/api-reference/check-sessions/retrieve-a-check-session.mdx index 9b732e76..7df50494 100644 --- a/api-reference/check-sessions/retrieve-a-check-session.mdx +++ b/api-reference/check-sessions/retrieve-a-check-session.mdx @@ -1,3 +1,4 @@ --- openapi: get /v1/check-sessions/{checkSessionId} ---- \ No newline at end of file +deprecated: true +--- diff --git a/api-reference/check-sessions/trigger-a-new-check-session.mdx b/api-reference/check-sessions/trigger-a-new-check-session.mdx index c5dcbf9b..8c304e6a 100644 --- a/api-reference/check-sessions/trigger-a-new-check-session.mdx +++ b/api-reference/check-sessions/trigger-a-new-check-session.mdx @@ -1,3 +1,4 @@ --- openapi: post /v1/check-sessions/trigger ---- \ No newline at end of file +deprecated: true +--- diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index 340416a8..21f41114 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -80,7 +80,7 @@ Because no alert is sent and the check status does not change, [automated incide Cancellation introduces two API additions: a new `CANCELLED` value on the check-session status enum, and a new `isCancelled` boolean on individual check results. The status enum change is breaking for clients that switch on status values exhaustively, so it's only exposed through the v2 check-session endpoints; v1 clients continue to work unchanged. The `isCancelled` flag is additive and ships on the existing check-result endpoints without a version bump. - + [`POST /v1/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session), [`GET /v1/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session), and [`GET /v1/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session) never return `CANCELLED` in `status` and do not include `isCancelled` on per-result objects. From 82c0fb69c08184baf3c04a712eb3d6c24e43a469 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 13 May 2026 16:38:05 +0200 Subject: [PATCH 03/13] docs: add descriptions to v2 check-session reference pages The v2 OpenAPI entries have no description fields, so the auto-rendered pages were blank. Carry the v1 description text forward in the MDX body and add a What's new in v2 note covering the CANCELLED status value and isCancelled result flag. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../await-the-completion-of-a-check-session-v2.mdx | 10 ++++++++++ .../check-sessions/retrieve-a-check-session-v2.mdx | 10 ++++++++++ .../trigger-a-new-check-session-v2.mdx | 12 ++++++++++++ 3 files changed, 32 insertions(+) diff --git a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx index d24029a8..5b2f4e6a 100644 --- a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx +++ b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx @@ -1,3 +1,13 @@ --- openapi: get /v2/check-sessions/{checkSessionId}/completion --- + +Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, or is cancelled). + +If the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable. + +The successful response of this endpoint is equivalent to the [retrieve a check session](/api-reference/check-sessions/retrieve-a-check-session-v2) endpoint's response for a completed check session. + + +**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. + diff --git a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx index 10ee5c0d..092e7c6d 100644 --- a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx +++ b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx @@ -1,3 +1,13 @@ --- openapi: get /v2/check-sessions/{checkSessionId} --- + +Retrieves a check session. Results may be incomplete if the check session is still in progress. + +Once a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `"FINAL"`, and zero or more results with `resultType` equal to `"ATTEMPT"` (one for each failed attempt, if any). + +Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the [retrieve a check result](/api-reference/check-results/retrieve-a-check-result) endpoint. + + +**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. + diff --git a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx index 72deac5a..7e9da64f 100644 --- a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx +++ b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx @@ -1,3 +1,15 @@ --- openapi: post /v2/check-sessions/trigger --- + +Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks. + +This endpoint does not wait for the check session to complete. Use the [await completion](/api-reference/check-sessions/await-the-completion-of-a-check-session-v2) or [retrieve check session](/api-reference/check-sessions/retrieve-a-check-session-v2) endpoints to track progress if needed. + +Standard alerting rules apply to finished check runs. + +Equivalent to the _Schedule Now_ button in the UI. + + +**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. + From ffa704684c3653a6fb861e8c0cdee2c645a1fcbd Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 13 May 2026 16:40:11 +0200 Subject: [PATCH 04/13] docs: add description to the cancel endpoint reference page The /v1/cancel OpenAPI entry has no description, so the auto-rendered page only showed the request schema. Add MDX body content explaining the discriminated body (checkSessionId vs testSessionId), the optional sequenceId narrowing, and the Playwright-only constraint, with a link out to the cancellation concept page. Co-Authored-By: Claude Opus 4.7 (1M context) --- api-reference/cancel/cancel-a-session.mdx | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/api-reference/cancel/cancel-a-session.mdx b/api-reference/cancel/cancel-a-session.mdx index 4a28cd12..5ee7e40e 100644 --- a/api-reference/cancel/cancel-a-session.mdx +++ b/api-reference/cancel/cancel-a-session.mdx @@ -3,3 +3,12 @@ openapi: post /v1/cancel title: Cancel a check or test session sidebarTitle: Cancel a session --- + +Stops an in-progress check session or test session by ID. The request body discriminates by which ID you pass: + +- Pass a `checkSessionId` to cancel a [check session](/api-reference/check-sessions/retrieve-a-check-session-v2) (UI "Schedule now" or `checkly deploy`). +- Pass a `testSessionId` to cancel a [test session](/detect/testing/overview) (`checkly test`, `checkly trigger`, or `checkly pw-test`). + +Optionally pass `sequenceId` (a single UUID or an array) to cancel only specific runs within the session. Omit it to cancel every in-progress run. + +Only Playwright Check Suite runs are cancellable. If a test session also contains URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs, those continue executing until they finish normally. See [Cancellation](/concepts/cancellation) for the full flow, the effect on alerts and metrics, and how the `CANCELLED` status and `isCancelled` flag surface in responses. From 3574b3d2463444169628b0458bb9dc2b8f45a1e6 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 15 May 2026 15:02:50 +0200 Subject: [PATCH 05/13] docs: clarify v1 vs v2 check-session cancellation behavior The only v2-only addition is the CANCELLED status enum value; v1 maps cancelled sessions to TIMED_OUT. The isCancelled boolean on per-result objects is additive and present in both versions. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../await-the-completion-of-a-check-session-v2.mdx | 2 +- .../check-sessions/retrieve-a-check-session-v2.mdx | 2 +- .../check-sessions/trigger-a-new-check-session-v2.mdx | 2 +- concepts/cancellation.mdx | 8 ++++---- 4 files changed, 7 insertions(+), 7 deletions(-) diff --git a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx index 5b2f4e6a..cd6b113e 100644 --- a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx +++ b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx @@ -9,5 +9,5 @@ If the check session takes a long time to complete, the endpoint will return a t The successful response of this endpoint is equivalent to the [retrieve a check session](/api-reference/check-sessions/retrieve-a-check-session-v2) endpoint's response for a completed check session. -**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. +**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. diff --git a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx index 092e7c6d..335d452f 100644 --- a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx +++ b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx @@ -9,5 +9,5 @@ Once a check session has finished, results will include at least one check resul Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the [retrieve a check result](/api-reference/check-results/retrieve-a-check-result) endpoint. -**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. +**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. diff --git a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx index 7e9da64f..992d9357 100644 --- a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx +++ b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx @@ -11,5 +11,5 @@ Standard alerting rules apply to finished check runs. Equivalent to the _Schedule Now_ button in the UI. -**What's new in v2:** `status` may return the new `CANCELLED` value for sessions that were [cancelled](/concepts/cancellation), and every per-result object includes an `isCancelled` boolean. v1 clients continue to work unchanged and never see these additions. +**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index 21f41114..cb567c7e 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -78,14 +78,14 @@ Because no alert is sent and the check status does not change, [automated incide ## API versioning -Cancellation introduces two API additions: a new `CANCELLED` value on the check-session status enum, and a new `isCancelled` boolean on individual check results. The status enum change is breaking for clients that switch on status values exhaustively, so it's only exposed through the v2 check-session endpoints; v1 clients continue to work unchanged. The `isCancelled` flag is additive and ships on the existing check-result endpoints without a version bump. +Cancellation introduces two API additions: a new `CANCELLED` value on the check-session status enum, and a new `isCancelled` boolean on individual check results. The `isCancelled` flag is additive and ships on every check-result and check-session response without a version bump. The status enum change is breaking for clients that switch on status values exhaustively, so the new `CANCELLED` value is only returned by the v2 check-session endpoints; v1 maps cancelled sessions to `TIMED_OUT` in `status` so existing clients continue to work unchanged. -[`POST /v1/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session), [`GET /v1/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session), and [`GET /v1/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session) never return `CANCELLED` in `status` and do not include `isCancelled` on per-result objects. +[`POST /v1/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session), [`GET /v1/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session), and [`GET /v1/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session) report cancelled sessions as `TIMED_OUT` in `status` rather than `CANCELLED`. Per-result objects still include `isCancelled`, so individual cancelled runs remain identifiable. -[`POST /v2/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session-v2), [`GET /v2/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session-v2), and [`GET /v2/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session-v2) return `CANCELLED` in `status` and include `isCancelled` on each per-result object. +[`POST /v2/check-sessions/trigger`](/api-reference/check-sessions/trigger-a-new-check-session-v2), [`GET /v2/check-sessions/{checkSessionId}`](/api-reference/check-sessions/retrieve-a-check-session-v2), and [`GET /v2/check-sessions/{checkSessionId}/completion`](/api-reference/check-sessions/await-the-completion-of-a-check-session-v2) return `CANCELLED` in `status` for cancelled sessions. Response shape is otherwise the same as v1. @@ -96,4 +96,4 @@ Cancellation introduces two API additions: a new `CANCELLED` value on the check- [`POST /v1/cancel`](/api-reference/cancel/cancel-a-session) is the action endpoint itself. It accepts either a `checkSessionId` or a `testSessionId` in the body, so a single endpoint covers both. -If you build automation against check sessions and want to handle cancelled runs explicitly, switch to the v2 endpoints. +If you build automation against check sessions and need to distinguish cancelled sessions from genuine timeouts at the session level, switch to the v2 endpoints. Otherwise, the `isCancelled` flag on per-result objects is available in both versions. From 05ecd89e69a69a656926dc75391f9a832c529f2b Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 20 May 2026 17:38:25 +0200 Subject: [PATCH 06/13] docs: correct CLI cancellation behavior and document --detach MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Verified the Ctrl+C cancellation behavior against the checkly-cli RED-375 branch: - Remove the "Cancelling a deploy" section — checkly deploy has no cancellation handling. - Note that cancellation requires a recorded test session (checkly test/trigger --record; pw-test records by default). - Document the --detach flag on pw-test, test, and trigger, and fix the default: Ctrl+C opens a cancel prompt by default, and --detach is the opt-in flag to skip it. Co-Authored-By: Claude Opus 4.7 (1M context) --- cli/checkly-deploy.mdx | 9 --------- cli/checkly-pw-test.mdx | 17 ++++++++++++++++- cli/checkly-test.mdx | 17 ++++++++++++++++- cli/checkly-trigger.mdx | 17 ++++++++++++++++- concepts/cancellation.mdx | 4 ++-- 5 files changed, 50 insertions(+), 14 deletions(-) diff --git a/cli/checkly-deploy.mdx b/cli/checkly-deploy.mdx index f8b30777..1ad5c0cf 100644 --- a/cli/checkly-deploy.mdx +++ b/cli/checkly-deploy.mdx @@ -178,15 +178,6 @@ The Checkly CLI evaluates Git information from your local or CI environment on a -## Cancelling a deploy - -{/* TODO: confirm CLI version that ships deploy Ctrl+C handling and fill in the Note below. */} -Available in CLI vX.X+. - -`checkly deploy` may run [Playwright Check Suites](/detect/synthetic-monitoring/playwright-checks/overview) as part of post-deploy verification. Pressing Ctrl+C during that phase prompts you to either **cancel** the recorded check session or **detach** and let it finish in the background. Detach is the default. - -See [Cancellation](/concepts/cancellation) for the full flow. - ## Related Commands - [`checkly login`](/cli/checkly-login) - Log in to your Checkly account diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index 80e4f723..0b4142e0 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -36,6 +36,7 @@ Define `checkly pw-test` specific options before the `--` separator: |--------|----------|-------------| | `--config` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | | `--create-check` | - | Create a Checkly check from the Playwright test. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | | `--env, -e` | - | Env vars to be passed to the test run. Default: [] | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--include, -i` | - | File patterns to include when bundling the test project (e.g., `"utils/**/*"`). Can be repeated. | @@ -125,6 +126,18 @@ const config = defineConfig({ + + +Skip the cancellation prompt. By default, pressing Ctrl+C during a `pw-test` run opens a prompt to cancel the recorded test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. + +**Usage:** + +```bash Terminal +npx checkly pw-test --detach +``` + + + Pass environment variables to the test run. Can be specified multiple times to set multiple variables. @@ -437,7 +450,9 @@ npx checkly pw-test -- test.spec.ts {/* TODO: confirm CLI version that ships pw-test Ctrl+C handling and fill in the Note below. */} Available in CLI vX.X+. -Press Ctrl+C during a `checkly pw-test` run to cancel the test session. The CLI sends a cancel request and waits for the runner to stop. Pressing Ctrl+C a second time exits the CLI without waiting. +Cancellation is available only for recorded test sessions. `pw-test` records by default, so its runs can be cancelled unless you pass `--no-record`. + +Press Ctrl+C during a `checkly pw-test` run to open a cancellation prompt. Pressing Ctrl+C a second time exits the CLI without waiting. Pass the `--detach` flag to skip the prompt entirely — Ctrl+C then exits immediately and the checks keep running in the cloud. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index b6b9640f..3b08cad8 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -21,6 +21,7 @@ npx checkly test [arguments] [options] | Option | Required | Description | |--------|----------|-------------| | `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | | `--env, -e` | - | Env vars to be passed to the test run. Can be used multiple times. | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--grep, -g` | - | Only run checks where the check name matches a regular expression. Default: `.*` | @@ -53,6 +54,18 @@ npx checkly test -c="./checkly.staging.config.ts" + + +Skip the cancellation prompt. By default, pressing Ctrl+C during a recorded run opens a prompt to cancel the test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. + +**Usage:** + +```bash Terminal +npx checkly test --record --detach +``` + + + [Environment variables](/cli/environment-variables) to be passed to the test run. Can be used multiple times. @@ -385,7 +398,9 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD {/* TODO: confirm CLI version that ships test Ctrl+C handling and fill in the Note below. */} Available in CLI vX.X+. -When you started the run with `--record`, pressing Ctrl+C prompts you to either **cancel** the recorded test session in Checkly or **detach** and let it finish in the background. Detach is the default. Cancellation only applies to Playwright Check Suite runs inside the session. +When you run with `--record`, pressing Ctrl+C opens a prompt to cancel the recorded test session. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. + +Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 20ef811b..306cf2db 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -21,6 +21,7 @@ npx checkly trigger [options] | Option | Required | Description | |--------|----------|-------------| | `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | | `--env, -e` | - | Env vars to be passed to the check run. Default: empty. Multiple values can be passed. | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--fail-on-no-matching` | - | Exit with a failing status code when there are no matching tests. | @@ -50,6 +51,18 @@ npx checkly trigger -c="./checkly.staging.config.ts" + + +Skip the cancellation prompt. By default, pressing Ctrl+C during a recorded run opens a prompt to cancel the test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. + +**Usage:** + +```bash Terminal +npx checkly trigger --record --detach +``` + + + [Environment variables](/cli/environment-variables) to be passed to the check run. Multiple values can be passed and passed variables overwrite any existing variables stored in your Checkly account. @@ -377,7 +390,9 @@ npx checkly trigger --tags staging --record --test-session-name "Pre-prod valida {/* TODO: confirm CLI version that ships trigger Ctrl+C handling and fill in the Note below. */} Available in CLI vX.X+. -When you started the run with `--record`, pressing Ctrl+C prompts you to either **cancel** the recorded test session in Checkly or **detach** and let it finish in the background. Detach is the default. Cancellation only applies to Playwright Check Suite runs inside the session. +When you run with `--record`, pressing Ctrl+C opens a prompt to cancel the recorded test session. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. + +Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index cb567c7e..dd4061af 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -12,7 +12,7 @@ You can cancel two kinds of sessions, and the behaviour differs: **Check sessions** — created by the UI "Schedule now" button and `checkly deploy`. A check session is one execution of a single Playwright Check Suite, fanned out across the locations you configured. Cancelling the session stops every in-progress run; cancelling a single run leaves the rest of the session going. -**Test sessions** — created by `checkly test`, `checkly trigger`, and `checkly pw-test`. A test session can contain multiple checks of different types. Cancelling the test session stops only the Playwright Check Suite runs inside it; any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs in the same session continue until they finish normally. You can also cancel a single Playwright run within the session. +**Test sessions** — created by `checkly test --record`, `checkly trigger --record`, and `checkly pw-test` (which records by default). A test session can contain multiple checks of different types. Cancelling the test session stops only the Playwright Check Suite runs inside it; any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs in the same session continue until they finish normally. You can also cancel a single Playwright run within the session. **Only Playwright Check Suite runs are cancellable.** Other check types cannot be cancelled, even when they appear inside a test session alongside Playwright runs. Scheduled runs are also excluded; cancellation is for user-initiated runs only. @@ -46,7 +46,7 @@ curl -X POST https://api.checklyhq.com/v1/cancel \ -Press Ctrl+C during `checkly pw-test`, `checkly test`, `checkly trigger`, or `checkly deploy`. The CLI prompts you to either cancel the running session or detach (let it finish in the background). +Press Ctrl+C during a recorded test session run — `checkly pw-test` (records by default), `checkly test --record`, or `checkly trigger --record` — to open a cancellation prompt. See the [CLI reference](/cli/overview) for command-specific behavior. From 0b5cab6d218174fdb74518e57e48652eb586fa7e Mon Sep 17 00:00:00 2001 From: miliberlin Date: Wed, 20 May 2026 17:51:29 +0200 Subject: [PATCH 07/13] docs: sync v2 check-session and cancel endpoint specs [RED-512] Recovers the work from commit e4c25ee, which was dropped during a rebase onto the updated remote branch. The RED-512 backend changes are in the production OpenAPI spec, so the v2 check-session and /v1/cancel endpoints carry full request, response, and description content. Strip the manually-written prose from the three v2 check-session pages so the synced spec drives their content, matching the v1 pages. Co-Authored-By: Claude Opus 4.7 (1M context) --- .../await-the-completion-of-a-check-session-v2.mdx | 10 ---------- .../check-sessions/retrieve-a-check-session-v2.mdx | 10 ---------- .../trigger-a-new-check-session-v2.mdx | 12 ------------ api-reference/openapi.json | 10 +++++----- 4 files changed, 5 insertions(+), 37 deletions(-) diff --git a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx index cd6b113e..d24029a8 100644 --- a/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx +++ b/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.mdx @@ -1,13 +1,3 @@ --- openapi: get /v2/check-sessions/{checkSessionId}/completion --- - -Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, or is cancelled). - -If the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable. - -The successful response of this endpoint is equivalent to the [retrieve a check session](/api-reference/check-sessions/retrieve-a-check-session-v2) endpoint's response for a completed check session. - - -**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. - diff --git a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx index 335d452f..10ee5c0d 100644 --- a/api-reference/check-sessions/retrieve-a-check-session-v2.mdx +++ b/api-reference/check-sessions/retrieve-a-check-session-v2.mdx @@ -1,13 +1,3 @@ --- openapi: get /v2/check-sessions/{checkSessionId} --- - -Retrieves a check session. Results may be incomplete if the check session is still in progress. - -Once a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `"FINAL"`, and zero or more results with `resultType` equal to `"ATTEMPT"` (one for each failed attempt, if any). - -Each result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the [retrieve a check result](/api-reference/check-results/retrieve-a-check-result) endpoint. - - -**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. - diff --git a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx index 992d9357..72deac5a 100644 --- a/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx +++ b/api-reference/check-sessions/trigger-a-new-check-session-v2.mdx @@ -1,15 +1,3 @@ --- openapi: post /v2/check-sessions/trigger --- - -Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks. - -This endpoint does not wait for the check session to complete. Use the [await completion](/api-reference/check-sessions/await-the-completion-of-a-check-session-v2) or [retrieve check session](/api-reference/check-sessions/retrieve-a-check-session-v2) endpoints to track progress if needed. - -Standard alerting rules apply to finished check runs. - -Equivalent to the _Schedule Now_ button in the UI. - - -**v2 vs v1:** v2 returns the new `CANCELLED` value in `status` for sessions that were [cancelled](/concepts/cancellation). v1 reports the same sessions as `TIMED_OUT` for backward compatibility. The response shape is otherwise identical, including the `isCancelled` boolean on per-result objects. - diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 2ad4d8b9..8827d554 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -6,7 +6,7 @@ keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set **Authorization** header while using cURL: `curl -H \"Authorization: Bearer [apiKey]\" \"X-Checkly-Account: [accountId]\"` -"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":"null","nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":"null","nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"enum":[{"value":{}}],"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":"null","enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":"null","nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":"null","nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":"null","nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":"null","nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/x-alt-definitions/RetryStrategy"},{"$ref":"#/x-alt-definitions/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/x-alt-definitions/RetryStrategy"},{"$ref":"#/x-alt-definitions/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/x-alt-definitions/RetryStrategy"},{"$ref":"#/x-alt-definitions/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":"null","nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":"null","nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":"null","nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":"null","nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":"null","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":"null","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":"null","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":"null","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":"null","default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":"null","default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25 12:34:56","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25 13:34:56","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25 12:34:56","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25 13:34:56","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date","description":"The timestamp when last the incident update.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25 12:34:56","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25 13:34:56","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25 12:34:56","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25 13:34:56","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date","description":"The timestamp when last the incident update.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":"null","default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":"null","nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":"null","default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":"null","nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-17T03:10:12.649Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-17T03:10:12.742Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"Model247":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"Model248":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model247"}},"TriggerTestSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/Model248"},"checkId":{"$ref":"#/components/schemas/checkId"},"allowDeactivated":{"type":"boolean","description":"Allow deactivated checks to match.","default":false}}},"Model249":{"type":"array","maxItems":50,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","description":"A short description for the testing environment.","example":"production"},"repoUrl":{"type":"string","example":"https://github.com/checkly/checkly-cli","nullable":true},"commitId":{"type":"string","example":"4b7b0828ebe1545a17d5cf2e934d6853d870955e","nullable":true},"commitOwner":{"type":"string","example":"dependabot[bot]","nullable":true},"commitMessage":{"type":"string","example":"chore(deps): bump actions/checkout from 4 to 5","nullable":true},"branchName":{"type":"string","example":"main","nullable":true}}},"TriggerTestSessionRequestPayload":{"type":"object","properties":{"name":{"type":"string","description":"The name of the test session.","example":"E2E tests"},"runLocation":{"type":"string","description":"The location to run checks from. Accepts a public region code (e.g. `us-east-1`) or a private location slug name.","example":"us-east-1"},"target":{"$ref":"#/components/schemas/TriggerTestSessionTarget"},"environmentVariables":{"$ref":"#/components/schemas/Model249"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"Model250":{"type":"string","description":"The status of the test session.","example":"PASSED","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"CheckType":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model251":{"type":"string","description":"The type of the result. `PENDING` means the check is still running. `ATTEMPT` is a failed retry attempt. `FINAL` is the definitive result.","example":"FINAL","enum":["FINAL","ATTEMPT","PENDING"]},"Model252":{"type":"string","description":"The status of the test session.","example":"PASSED","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"TestSessionConciseResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","description":"The ID of the test session result.","example":"42406a0f-5864-4a26-9884-7c5d1be15bc2","x-format":{"guid":true}},"testSessionResultLink":{"type":"string","description":"A link to the test session result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/test-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/42406a0f-5864-4a26-9884-7c5d1be15bc2","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/CheckType"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model251"},"status":{"$ref":"#/components/schemas/Model252"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false}},"required":["testSessionResultId","testSessionResultLink","checkType","status","hasErrors","hasFailures","isDegraded","aborted"]},"Model253":{"type":"array","description":"The results of the test session. When a retry strategy is configured, a check may produce multiple results: one `PENDING` while running, zero or more `ATTEMPT` entries for failed retries, and one `FINAL` entry with the definitive outcome.","items":{"$ref":"#/components/schemas/TestSessionConciseResult"}},"TriggerTestSessionResponse":{"type":"object","description":"Details of the new test session.","properties":{"testSessionId":{"type":"string","description":"The unique identifier of the test session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"testSessionLink":{"type":"string","description":"A link to the test session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/test-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"name":{"type":"string","description":"The name of the test session."},"status":{"$ref":"#/components/schemas/Model250"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the test session took, in milliseconds.","example":300731},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"$ref":"#/components/schemas/Model253"}},"required":["testSessionId","testSessionLink","name","status","startedAt","timeElapsed"]},"Model254":{"type":"string","description":"The status of the test session.","example":"PASSED","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"Model255":{"type":"array","description":"The results of the test session. When a retry strategy is configured, a check may produce multiple results: one `PENDING` while running, zero or more `ATTEMPT` entries for failed retries, and one `FINAL` entry with the definitive outcome.","items":{"$ref":"#/components/schemas/TestSessionConciseResult"}},"FindOneTestSessionResponse":{"type":"object","description":"The current state of the test session.","properties":{"testSessionId":{"type":"string","description":"The unique identifier of the test session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"testSessionLink":{"type":"string","description":"A link to the test session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/test-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"name":{"type":"string","description":"The name of the test session."},"status":{"$ref":"#/components/schemas/Model254"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the test session took, in milliseconds.","example":300731},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"$ref":"#/components/schemas/Model255"}},"required":["testSessionId","testSessionLink","name","status","startedAt","timeElapsed"]},"TestSessionNotFoundErrorResponse":{"type":"object","description":"No such test session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such test session."}},"required":["statusCode"]},"Model256":{"type":"string","description":"The final status of the test session.","example":"PASSED","enum":["FAILED","PASSED","CANCELLED"]},"Model257":{"type":"array","description":"The results of the test session. When a retry strategy is configured, a check may produce multiple results: one `PENDING` while running, zero or more `ATTEMPT` entries for failed retries, and one `FINAL` entry with the definitive outcome.","items":{"$ref":"#/components/schemas/TestSessionConciseResult"}},"AwaitTestSessionCompletionResponse":{"type":"object","description":"Returned when the test session has finished running.","properties":{"testSessionId":{"type":"string","description":"The unique identifier of the test session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"testSessionLink":{"type":"string","description":"A link to the test session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/test-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"name":{"type":"string","description":"The name of the test session."},"status":{"$ref":"#/components/schemas/Model256"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the test session took, in milliseconds.","example":300731},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"$ref":"#/components/schemas/Model257"}},"required":["testSessionId","testSessionLink","name","status","startedAt","stoppedAt","timeElapsed"]},"AwaitTestSessionCompletionTryAgainResponse":{"type":"object","description":"The test session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Test session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model258":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model259":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model260":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model259"}},"Model261":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model262":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model263":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model264":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model265":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model266":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model264"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model265"},"reminders":{"$ref":"#/components/schemas/Model266"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model260"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model261"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model262"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":"null","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":"null","default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model263"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/x-alt-definitions/RetryStrategy"},{"$ref":"#/x-alt-definitions/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. +"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"TriggerTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","minLength":1,"description":"A short description for the testing environment."},"repoUrl":{"type":"string","nullable":true},"commitId":{"type":"string","nullable":true},"commitOwner":{"type":"string","nullable":true},"commitMessage":{"type":"string","nullable":true},"branchName":{"type":"string","nullable":true}}},"TestSessionResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","format":"uuid"},"testSessionResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","nullable":true,"format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups associated with this result."},"resultType":{"type":"string","enum":["FINAL","ATTEMPT","PENDING"]},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"}},"required":["testSessionResultId","testSessionResultLink","checkType","errorGroupIds","status","hasErrors","hasFailures","isDegraded","aborted"]},"TriggerTestSessionRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the test session."},"runLocation":{"type":"string","minLength":1,"description":"A public region code or private location slug name."},"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."},"allowDeactivated":{"type":"boolean","default":false,"description":"Allow deactivated checks to match."}}},"environmentVariables":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionEnvironmentVariable"},"maxItems":50},"retryStrategy":{"anyOf":[{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["FIXED","LINEAR","EXPONENTIAL"]},"maxRetries":{"type":"number","minimum":1,"maximum":10,"default":2},"maxDurationSeconds":{"type":"number","minimum":0,"maximum":600,"default":600}},"required":["type"]},{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["SINGLE_RETRY"]}},"required":["type"]},{"nullable":true}]},"refreshCache":{"type":"boolean","default":false,"description":"Skip existing caches and install dependencies from scratch."},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"TestSessionEnvironmentVariable":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"nullable":true},"secret":{"type":"boolean","enum":[true]}},"required":["key","value","secret"]},{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"type":"string","nullable":true,"minLength":1},"secret":{"type":"boolean","enum":[false],"default":false}},"required":["key","value"]}]},"CancelRequest":{"anyOf":[{"$ref":"#/components/schemas/CancelCheckSession"},{"$ref":"#/components/schemas/CancelTestSession"}]},"CancelCheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid","description":"The ID of the check session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["checkSessionId"],"additionalProperties":false},"SequenceIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."},"CancelTestSession":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid","description":"The ID of the test session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["testSessionId"],"additionalProperties":false},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AwaitTestSessionCompletionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","stoppedAt","timeElapsed"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"FindOneTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":null,"nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":null,"nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":null,"nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":null,"nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.773Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.868Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model247":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model248":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model249":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model248"}},"Model250":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model251":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model252":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model253":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model254":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model255":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model253"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model254"},"reminders":{"$ref":"#/components/schemas/Model255"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model249"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model250"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model251"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model252"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 24-hour timeframe. If the `from` and `to` params are set, they must be at most 24 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 24 hours earlier. If only the `to` param is set we will set `from` to be 24 hours earlier. If only the `from` param is set we will consider the `to` param to be 24 hours later. @@ -26,7 +26,7 @@ Currently only `quickRange` is supported for time filtering. Arbitrary `from`/`t **Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["total","dns","connection","data","availability","retries","total_avg","total_max","total_median","total_min","total_p50","total_p90","total_p95","total_p99","total_stddev","total_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","connection_avg","connection_max","connection_median","connection_min","connection_p50","connection_p90","connection_p95","connection_p99","connection_stddev","connection_sum","data_avg","data_max","data_median","data_min","data_p50","data_p90","data_p95","data_p99","data_stddev","data_sum"]}},"description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model35"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/analytics/url-monitors/{id}":{"get":{"summary":"URL Monitors","operationId":"getV1AnalyticsUrlmonitorsId","description":"Fetch detailed availability metrics and aggregated or non-aggregated API Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the DNS phases of your API check together with the availability percentage for any time range. -**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/cancel":{"post":{"summary":"Cancel a check run, check session, test run, or test session","operationId":"cancel","tags":["cancel"],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/x-alt-definitions/CancelCheckSession"},{"$ref":"#/x-alt-definitions/CancelTestSession"}]}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. +**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/cancel":{"post":{"summary":"Cancel a check run, check session, test run, or test session","operationId":"postV1Cancel","description":"Cancels in-progress Playwright Check Suite runs. The request body must reference exactly one of `checkSessionId` or `testSessionId`. A `checkSessionId` is obtained from `POST /v2/check-sessions/trigger`. Use the optional `sequenceId` field to cancel only specific parallel runs within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. The response does not confirm whether the session was found or eligible — use `GET /v2/check-sessions/{checkSessionId}` to verify the resulting state.","tags":["cancel"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most 6 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 6 hours earlier. If only the `to` param is set we will set `from` to be 6 hours earlier. If only the `from` param is set we will consider the `to` param to be 6 hours later.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."}],"tags":["Check alerts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAlertList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-alerts/{checkId}":{"get":{"summary":"List alerts for a specific check","operationId":"getV1CheckalertsCheckid","description":"Lists all the alerts for a specific check. @@ -37,12 +37,12 @@ You can filter by check type and result type to narrow down the list. Use the `t This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most six hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be six hours earlier. If only the `to` param is set we will set `from` to be six hours earlier. On the contrary, if only the `from` param is set we will consider the `to` param to be six hours later. -**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-results/{checkId}/{checkResultId}":{"get":{"summary":"Retrieve a check result","operationId":"getV1CheckresultsCheckidCheckresultid","description":"Show details of a specific check result.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"checkResultId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV1ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v1/check-sessions/{checkSessionId}/completion` or `GET /v1/check-sessions/{checkSessionId}` endpoints to track progress if needed.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionRequestPayload"}}}},"responses":{"201":{"description":"Returns a check session for each check matching target conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Returned when there are no matching checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoMatchingChecksFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV1ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true}],"tags":["Check sessions"],"responses":{"200":{"description":"The current state of the check session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV1ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true},{"name":"maxWaitSeconds","in":"query","schema":{"type":"number","description":"The maximum time to wait for completion, in seconds.","example":30,"minimum":1,"maximum":30},"description":"The maximum time to wait for completion, in seconds."}],"tags":["Check sessions"],"responses":{"200":{"description":"Returned when the check session has finished running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"408":{"description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionTryAgainResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-statuses":{"get":{"summary":"List all check statuses","operationId":"getV1Checkstatuses","description":"Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatusList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-statuses/{checkId}":{"get":{"summary":"Retrieve check status details","operationId":"getV1CheckstatusesCheckid","description":"Show the current status information for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatus"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks":{"get":{"summary":"List all checks","operationId":"getV1Checks","description":"Lists all current checks in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"apiCheckUrlFilterPattern","in":"query","schema":{"type":"string","description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks.","minLength":1},"description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks."},{"name":"tag","in":"query","schema":{"type":"array","description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","style":"form","explode":true},{"name":"checkType","in":"query","schema":{"type":"string","description":"Filters checks by type. Returns checks that match the specified type.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"Filters checks by type. Returns checks that match the specified type."},{"name":"search","in":"query","schema":{"type":"string","description":"Filters checks by name using a case-insensitive partial match."},"description":"Filters checks by name using a case-insensitive partial match."},{"name":"status","in":"query","schema":{"type":"string","description":"Filters checks by current status.","enum":["passing","failing","degraded"]},"description":"Filters checks by current status."},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a check","operationId":"postV1Checks","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `POST /checks/api` or `POST /checks/browser`.** Creates a new API or browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSettings`, the `alertSettings` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/checks/api":{"post":{"summary":"Create an API check","operationId":"postV1ChecksApi","description":"Creates a new API check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPICreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/api/{id}":{"put":{"summary":"Update an API check","operationId":"putV1ChecksApiId","description":"Updates an API check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPIUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser":{"post":{"summary":"Create a browser check","operationId":"postV1ChecksBrowser","description":"Creates a new browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser/{id}":{"put":{"summary":"Update a browser check","operationId":"putV1ChecksBrowserId","description":"Updates a browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns":{"post":{"summary":"Create an DNS monitor","operationId":"postV1ChecksDns","description":"Creates a new DNS monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDNSCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns/{id}":{"put":{"summary":"Update an DNS Monitor","operationId":"putV1ChecksDnsId","description":"Updates an DNS monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat":{"post":{"summary":"Create a heartbeat check","operationId":"postV1ChecksHeartbeat","description":"Creates a new Heartbeat check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat/{id}":{"put":{"summary":"Update a heartbeat check","operationId":"putV1ChecksHeartbeatId","description":"Updates a Heartbeat check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/availability":{"get":{"summary":"Get heartbeat availability","operationId":"getV1ChecksHeartbeatsCheckidAvailability","description":"Get heartbeat availability.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-16T03:10:11.569Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-17T03:10:11.570Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model131"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events":{"get":{"summary":"Get a list of events for a heartbeat","operationId":"getV1ChecksHeartbeatsCheckidEvents","description":"Get all events from a heartbeat.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-16T03:10:11.572Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-17T03:10:11.572Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model134"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events/{id}":{"get":{"summary":"Get a specific Heartbeat event","operationId":"getV1ChecksHeartbeatsCheckidEventsId","description":"Get a specific event by its id.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model135"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp":{"post":{"summary":"Create an ICMP monitor","operationId":"postV1ChecksIcmp","description":"Creates a new ICMP monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp/{id}":{"put":{"summary":"Update an ICMP Monitor","operationId":"putV1ChecksIcmpId","description":"Updates an ICMP monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep":{"post":{"summary":"Create a multi-step check","operationId":"postV1ChecksMultistep","description":"Creates a new Multi-Step check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep/{id}":{"put":{"summary":"Update a multi-step check","operationId":"putV1ChecksMultistepId","description":"Updates a Multi-Step check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp":{"post":{"summary":"Create a TCP check","operationId":"postV1ChecksTcp","description":"Creates a new TCP check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp/{id}":{"put":{"summary":"Update an TCP check","operationId":"putV1ChecksTcpId","description":"Updates an TCP check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url":{"post":{"summary":"Create a URL monitor","operationId":"postV1ChecksUrl","description":"Creates a new URL monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url/{id}":{"put":{"summary":"Update an URL Monitor","operationId":"putV1ChecksUrlId","description":"Updates an URL monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/{id}":{"delete":{"summary":"Delete a check","operationId":"deleteV1ChecksId","description":"Permanently removes a API or browser check and all its related status and results data.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Checks"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check","operationId":"getV1ChecksId","description":"Show details of a specific API or browser check","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeDependencies","in":"query","schema":{"type":"boolean","description":"Include check dependencies in the response"},"description":"Include check dependencies in the response"},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a check","operationId":"putV1ChecksId","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `PUT /checks/api/{id}` or `PUT /checks/browser/{id}`.** Updates a new API or browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/client-certificates":{"get":{"summary":"Lists all client certificates.","operationId":"getV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Creates a new client certificate.","operationId":"postV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/client-certificates/{id}":{"delete":{"summary":"Deletes a client certificate.","operationId":"deleteV1ClientcertificatesId","description":"Permanently removes a client certificate.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Shows one client certificate.","operationId":"getV1ClientcertificatesId","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards":{"get":{"summary":"List all dashboards","operationId":"getV1Dashboards","description":"Lists all current dashboards in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a dashboard","operationId":"postV1Dashboards","description":"Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards/{dashboardId}":{"delete":{"summary":"Delete a dashboard","operationId":"deleteV1DashboardsDashboardid","description":"Permanently removes a dashboard.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a dashboard","operationId":"getV1DashboardsDashboardid","description":"Show details of a specific dashboard. +**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-results/{checkId}/{checkResultId}":{"get":{"summary":"Retrieve a check result","operationId":"getV1CheckresultsCheckidCheckresultid","description":"Show details of a specific check result.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"checkResultId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV1ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v1/check-sessions/{checkSessionId}/completion` or `GET /v1/check-sessions/{checkSessionId}` endpoints to track progress if needed.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionRequestPayload"}}}},"responses":{"201":{"description":"Returns a check session for each check matching target conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Returned when there are no matching checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoMatchingChecksFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV1ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true}],"tags":["Check sessions"],"responses":{"200":{"description":"The current state of the check session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV1ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true},{"name":"maxWaitSeconds","in":"query","schema":{"type":"number","description":"The maximum time to wait for completion, in seconds.","example":30,"minimum":1,"maximum":30},"description":"The maximum time to wait for completion, in seconds."}],"tags":["Check sessions"],"responses":{"200":{"description":"Returned when the check session has finished running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"408":{"description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionTryAgainResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-statuses":{"get":{"summary":"List all check statuses","operationId":"getV1Checkstatuses","description":"Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatusList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-statuses/{checkId}":{"get":{"summary":"Retrieve check status details","operationId":"getV1CheckstatusesCheckid","description":"Show the current status information for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatus"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks":{"get":{"summary":"List all checks","operationId":"getV1Checks","description":"Lists all current checks in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"apiCheckUrlFilterPattern","in":"query","schema":{"type":"string","description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks.","minLength":1},"description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks."},{"name":"tag","in":"query","schema":{"type":"array","description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","style":"form","explode":true},{"name":"checkType","in":"query","schema":{"type":"string","description":"Filters checks by type. Returns checks that match the specified type.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"Filters checks by type. Returns checks that match the specified type."},{"name":"search","in":"query","schema":{"type":"string","description":"Filters checks by name using a case-insensitive partial match."},"description":"Filters checks by name using a case-insensitive partial match."},{"name":"status","in":"query","schema":{"type":"string","description":"Filters checks by current status.","enum":["passing","failing","degraded"]},"description":"Filters checks by current status."},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a check","operationId":"postV1Checks","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `POST /checks/api` or `POST /checks/browser`.** Creates a new API or browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSettings`, the `alertSettings` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/checks/api":{"post":{"summary":"Create an API check","operationId":"postV1ChecksApi","description":"Creates a new API check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPICreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/api/{id}":{"put":{"summary":"Update an API check","operationId":"putV1ChecksApiId","description":"Updates an API check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPIUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser":{"post":{"summary":"Create a browser check","operationId":"postV1ChecksBrowser","description":"Creates a new browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser/{id}":{"put":{"summary":"Update a browser check","operationId":"putV1ChecksBrowserId","description":"Updates a browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns":{"post":{"summary":"Create an DNS monitor","operationId":"postV1ChecksDns","description":"Creates a new DNS monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDNSCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns/{id}":{"put":{"summary":"Update an DNS Monitor","operationId":"putV1ChecksDnsId","description":"Updates an DNS monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat":{"post":{"summary":"Create a heartbeat check","operationId":"postV1ChecksHeartbeat","description":"Creates a new Heartbeat check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat/{id}":{"put":{"summary":"Update a heartbeat check","operationId":"putV1ChecksHeartbeatId","description":"Updates a Heartbeat check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/availability":{"get":{"summary":"Get heartbeat availability","operationId":"getV1ChecksHeartbeatsCheckidAvailability","description":"Get heartbeat availability.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-19T15:50:39.669Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T15:50:39.669Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model131"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events":{"get":{"summary":"Get a list of events for a heartbeat","operationId":"getV1ChecksHeartbeatsCheckidEvents","description":"Get all events from a heartbeat.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-19T15:50:39.672Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T15:50:39.672Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model134"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events/{id}":{"get":{"summary":"Get a specific Heartbeat event","operationId":"getV1ChecksHeartbeatsCheckidEventsId","description":"Get a specific event by its id.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model135"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp":{"post":{"summary":"Create an ICMP monitor","operationId":"postV1ChecksIcmp","description":"Creates a new ICMP monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp/{id}":{"put":{"summary":"Update an ICMP Monitor","operationId":"putV1ChecksIcmpId","description":"Updates an ICMP monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep":{"post":{"summary":"Create a multi-step check","operationId":"postV1ChecksMultistep","description":"Creates a new Multi-Step check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep/{id}":{"put":{"summary":"Update a multi-step check","operationId":"putV1ChecksMultistepId","description":"Updates a Multi-Step check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp":{"post":{"summary":"Create a TCP check","operationId":"postV1ChecksTcp","description":"Creates a new TCP check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp/{id}":{"put":{"summary":"Update an TCP check","operationId":"putV1ChecksTcpId","description":"Updates an TCP check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url":{"post":{"summary":"Create a URL monitor","operationId":"postV1ChecksUrl","description":"Creates a new URL monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url/{id}":{"put":{"summary":"Update an URL Monitor","operationId":"putV1ChecksUrlId","description":"Updates an URL monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/{id}":{"delete":{"summary":"Delete a check","operationId":"deleteV1ChecksId","description":"Permanently removes a API or browser check and all its related status and results data.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Checks"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check","operationId":"getV1ChecksId","description":"Show details of a specific API or browser check","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeDependencies","in":"query","schema":{"type":"boolean","description":"Include check dependencies in the response"},"description":"Include check dependencies in the response"},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a check","operationId":"putV1ChecksId","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `PUT /checks/api/{id}` or `PUT /checks/browser/{id}`.** Updates a new API or browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/client-certificates":{"get":{"summary":"Lists all client certificates.","operationId":"getV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Creates a new client certificate.","operationId":"postV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/client-certificates/{id}":{"delete":{"summary":"Deletes a client certificate.","operationId":"deleteV1ClientcertificatesId","description":"Permanently removes a client certificate.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Shows one client certificate.","operationId":"getV1ClientcertificatesId","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards":{"get":{"summary":"List all dashboards","operationId":"getV1Dashboards","description":"Lists all current dashboards in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a dashboard","operationId":"postV1Dashboards","description":"Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards/{dashboardId}":{"delete":{"summary":"Delete a dashboard","operationId":"deleteV1DashboardsDashboardid","description":"Permanently removes a dashboard.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a dashboard","operationId":"getV1DashboardsDashboardid","description":"Show details of a specific dashboard. **Rate-limiting is applied to this endpoint, you can send 10 requests / 20 seconds at most.**","parameters":[{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"type":"string","enum":["customUrl","customDomain"]}}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a dashboard","operationId":"putV1DashboardsDashboardid","description":"Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model214"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups":{"get":{"summary":"List all error groups in your account.","operationId":"getV1Errorgroups","description":"List all error groups in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups/checks/{checkId}":{"get":{"summary":"List all error groups for a specific check.","operationId":"getV1ErrorgroupsChecksCheckid","description":"List all error groups for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups/{id}":{"get":{"summary":"Retrieve one error group.","operationId":"getV1ErrorgroupsId","description":"Retrieve one error group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"patch":{"summary":"Update an error group. Mainly used for archiving error groups.","operationId":"patchV1ErrorgroupsId","description":"Update an error group. Mainly used for archiving error groups.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Error Groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupPatch"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents":{"post":{"summary":"Create an incident","operationId":"postV1Incidents","description":"Creates a new incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model218"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model222"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{id}":{"delete":{"summary":"Delete an incident","operationId":"deleteV1IncidentsId","description":"Permanently removes an incident and all its updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incidents"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident","operationId":"getV1IncidentsId","description":"Shows details of a specific incident. Uses the \"includeAllIncidentUpdates\" query parameter to obtain all updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeAllIncidentUpdates","in":"query","schema":{"type":"boolean","description":"You use it to include all the incident updates.","example":true,"default":false},"description":"You use it to include all the incident updates."}],"tags":["Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model222"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an incident","operationId":"putV1IncidentsId","description":"Updates an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"probe","in":"query","schema":{"type":"boolean"}}],"tags":["Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model223"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model224"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{incidentId}/updates":{"post":{"summary":"Create an incident update","operationId":"postV1IncidentsIncidentidUpdates","description":"Creates a new update for an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model217"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{incidentId}/updates/{id}":{"delete":{"summary":"Delete an incident update","operationId":"deleteV1IncidentsIncidentidUpdatesId","description":"Permanently removes an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an incident update","operationId":"putV1IncidentsIncidentidUpdatesId","description":"Modifies an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model225"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model220"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/locations":{"get":{"summary":"Lists all supported locations","operationId":"getV1Locations","description":"Lists all supported locationss.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Location"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationList"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/maintenance-windows":{"get":{"summary":"List all maintenance windows","operationId":"getV1Maintenancewindows","description":"Lists all maintenance windows in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"startsAt","in":"query","schema":{"description":"Filter for items which startsAt field matches the constraint","anyOf":[{"type":"object","properties":{"gt":{"type":"string","format":"date"}},"required":["gt"]},{"type":"object","properties":{"gte":{"type":"string","format":"date"}},"required":["gte"]},{"type":"object","properties":{"lt":{"type":"string","format":"date"}},"required":["lt"]},{"type":"object","properties":{"lte":{"type":"string","format":"date"}},"required":["lte"]}]},"description":"Filter for items which startsAt field matches the constraint"},{"name":"endsAt","in":"query","schema":{"description":"Filter for items which endsAt field matches the constraint","anyOf":[{"type":"object","properties":{"gt":{"type":"string","format":"date"}},"required":["gt"]},{"type":"object","properties":{"gte":{"type":"string","format":"date"}},"required":["gte"]},{"type":"object","properties":{"lt":{"type":"string","format":"date"}},"required":["lt"]},{"type":"object","properties":{"lte":{"type":"string","format":"date"}},"required":["lte"]}]},"description":"Filter for items which endsAt field matches the constraint"}],"tags":["Maintenance windows"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a maintenance window","operationId":"postV1Maintenancewindows","description":"Creates a new maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Maintenance windows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/maintenance-windows/{id}":{"delete":{"summary":"Delete a maintenance window","operationId":"deleteV1MaintenancewindowsId","description":"Permanently removes a maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a maintenance window","operationId":"getV1MaintenancewindowsId","description":"Show details of a specific maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a maintenance window","operationId":"putV1MaintenancewindowsId","description":"Updates a maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations":{"get":{"summary":"List all private locations","operationId":"getV1Privatelocations","description":"Lists all private locations in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"versions","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsListSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a private location","operationId":"postV1Privatelocations","description":"Creates a new private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Private locations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commonPrivateLocationSchemaResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}":{"delete":{"summary":"Remove a private location","operationId":"deleteV1PrivatelocationsId","description":"Permanently removes a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a private location","operationId":"getV1PrivatelocationsId","description":"Show details of a specific private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a private location","operationId":"putV1PrivatelocationsId","description":"Updates a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commonPrivateLocationSchemaResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/keys":{"post":{"summary":"Generate a new API Key for a private location","operationId":"postV1PrivatelocationsIdKeys","description":"Creates an api key on the private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationKeys"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/keys/{keyId}":{"delete":{"summary":"Remove an existing API key for a private location","operationId":"deleteV1PrivatelocationsIdKeysKeyid","description":"Permanently removes an api key from a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"keyId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/metrics":{"get":{"summary":"Get private location health metrics from a window of time.","operationId":"getV1PrivatelocationsIdMetrics","description":"Get private location health metrics from a window of time. -**Rate-limiting is applied to this endpoint, you can send 300 requests per day at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago."},"description":"Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago.","required":true},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Select metrics up to this UNIX timestamp."},"description":"Select metrics up to this UNIX timestamp.","required":true}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsMetricsHistoryResponseSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/reporting":{"get":{"summary":"Generates a report with aggregate statistics for checks and check groups.","operationId":"getV1Reporting","description":"Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hrs","enum":["last24Hrs","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"filterByTags","in":"query","schema":{"type":"array","description":"Use tags to filter the checks you want to see in your report.","example":["production"],"x-constraint":{"single":true},"items":{"type":"string"}},"description":"Use tags to filter the checks you want to see in your report.","style":"form","explode":true},{"name":"deactivated","in":"query","schema":{"type":"boolean","description":"Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned.","default":null,"nullable":true},"description":"Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned."}],"tags":["Reporting"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/error-groups/{errorGroupId}":{"post":{"summary":"Generate a Root Cause Analysis for a check error group","operationId":"postV1RootcauseanalysesErrorgroupsErrorgroupid","description":"Asynchronously generates a root cause analysis for a specific check error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"errorGroupId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaErrorGroup"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model230"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}":{"post":{"summary":"Generate a Root Cause Analysis for a test session error group","operationId":"postV1RootcauseanalysesTestsessionerrorgroupsTestsessionerrorgroupid","description":"Asynchronously generates a root cause analysis for a specific test session error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"testSessionErrorGroupId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaErrorGroup"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaTestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/{id}":{"get":{"summary":"Retrieve a Root Cause Analysis","operationId":"getV1RootcauseanalysesId","description":"Retrieves a specific root cause analysis. Use the `id` returned from either POST endpoint and poll until the response is HTTP 200. While the analysis is being generated the endpoint returns HTTP 202 with `{\"id\":\"\",\"status\":\"PENDING\"}`. A genuine HTTP 404 means the ID does not exist. Works for both check error group and test session error group analyses.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRca"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRcaPending"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/runtimes":{"get":{"summary":"Lists all supported runtimes","operationId":"getV1Runtimes","description":"Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Runtimes"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntimeList"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/runtimes/{id}":{"get":{"summary":"Shows details for one specific runtime","operationId":"getV1RuntimesId","description":"Shows the details of all included NPM packages and their version for one specific runtime","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"tags":["Runtimes"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runtime"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/snippets":{"get":{"summary":"List all snippets","operationId":"getV1Snippets","description":"Lists all current snippets in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Snippets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a snippet","operationId":"postV1Snippets","description":"Creates a new snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Snippets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/snippets/{id}":{"delete":{"summary":"Delete a snippet","operationId":"deleteV1SnippetsId","description":"Permanently removes a snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a snippet","operationId":"getV1SnippetsId","description":"Show details of a specific snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a snippet","operationId":"putV1SnippetsId","description":"Updates a snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips":{"get":{"summary":"Lists all source IPs for check runs","operationId":"getV1Staticips","description":"Lists all source IPs for check runs as a single JSON array.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips-by-region":{"get":{"summary":"Lists all source IPs for check runs","operationId":"getV1Staticipsbyregion","description":"Lists all source IPs for check runs as object with regions as keys and an array of IPs as value.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips.txt":{"get":{"summary":"Lists all source IPs for check runs as txt file","operationId":"getV1Staticipstxt","description":"Lists all IPs for check runs as a TXT file. Each line has one IP.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s":{"get":{"summary":"Lists all source IPv6s for check runs","operationId":"getV1Staticipv6s","description":"Lists all source IPv6s for check runs as a single JSON array.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s-by-region":{"get":{"summary":"Lists all source IPv6s for check runs","operationId":"getV1Staticipv6sbyregion","description":"Lists all source IPs for check runs as an object with regions as keys and an Ipv6 as value.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s.txt":{"get":{"summary":"Lists all source IPv6s for check runs as a txt file","operationId":"getV1Staticipv6stxt","description":"Lists all IPv6s for check runs as a TXT file. Each line has one IP.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages":{"get":{"summary":"Retrieve all status pages.","operationId":"getV1Statuspages","description":"Get all status pages for an account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}}],"tags":["Status Pages"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPagesV2PaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a new status page.","operationId":"postV1Statuspages","description":"Create a new status page with its related services and cards.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Pages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2PublicApiUpdate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents":{"get":{"summary":"Retrieve the latest incidents with pagination.","operationId":"getV1StatuspagesIncidents","description":"Get the latest 100 incidents for all services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentsPaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a new incident.","operationId":"postV1StatuspagesIncidents","description":"Creates a new incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatusPageV2Incident"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}":{"delete":{"summary":"Delete an incident.","operationId":"deleteV1StatuspagesIncidentsIncidentid","description":"Permanently removes an incident and all its updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident by id.","operationId":"getV1StatuspagesIncidentsIncidentid","description":"Get incident details including incident history and affected services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing incident.","operationId":"putV1StatuspagesIncidentsIncidentid","description":"Updates an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentCommon"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}/incident-updates":{"get":{"summary":"Retrieve the 100 latest incident updates of a specific incident.","operationId":"getV1StatuspagesIncidentsIncidentidIncidentupdates","description":"Lists all updates for a specific incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model239"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Add a new incident update to a specific incident.","operationId":"postV1StatuspagesIncidentsIncidentidIncidentupdates","description":"Creates a new update for an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}":{"delete":{"summary":"Delete an incident update.","operationId":"deleteV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Permanently removes an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident update by id.","operationId":"getV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Shows details of a specific incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing incident update.","operationId":"putV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Modifies an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/services":{"get":{"summary":"Get all services","operationId":"getV1StatuspagesServices","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}},{"name":"paginated","in":"query","schema":{"type":"boolean","default":true}}],"tags":["Status Page Services"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicesPaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a service","operationId":"postV1StatuspagesServices","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Page Services"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateService"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/services/{serviceId}":{"delete":{"summary":"Delete a service","operationId":"deleteV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Get a single service","operationId":"getV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a service","operationId":"putV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateService"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}":{"delete":{"summary":"Delete a status page.","operationId":"deleteV1StatuspagesStatuspageid","description":"Delete a status page.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a single status page by id.","operationId":"getV1StatuspagesStatuspageid","description":"Get status page data, including cards and services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing status page.","operationId":"putV1StatuspagesStatuspageid","description":"Update a status page with its related services and cards.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2PublicApiUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions":{"get":{"summary":"Get all subscriptions for a specific status page","operationId":"getV1StatuspagesStatuspageidSubscriptions","description":"Get all subscriptions for a specific status page","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"responses":{"200":{"description":"The list of subscriptions for the status page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions/bulk":{"post":{"summary":"Bulk create subscriptions for a specific status page","operationId":"postV1StatuspagesStatuspageidSubscriptionsBulk","description":"Bulk create subscriptions for a specific status page.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateSubscriptionsPayload"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateSubscriptionsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}":{"delete":{"summary":"Delete a subscription belonging to a specific status page","operationId":"deleteV1StatuspagesStatuspageidSubscriptionsSubscriptionid","description":"Delete a subscription belonging to a specific status page using the subscription id","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"subscriptionId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups":{"get":{"summary":"List all test session error groups in your account.","operationId":"getV1Testsessionerrorgroups","description":"List all test session error groups in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups/projects/{projectId}":{"get":{"summary":"List all test session error groups for a specific project.","operationId":"getV1TestsessionerrorgroupsProjectsProjectid","description":"List all test session error groups for a specific project.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"projectId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups/{id}":{"get":{"summary":"Retrieve one test session error group.","operationId":"getV1TestsessionerrorgroupsId","description":"Retrieve one test session error group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"patch":{"summary":"Update a test session error group. Mainly used for archiving test session error groups.","operationId":"patchV1TestsessionerrorgroupsId","description":"Update a test session error group. Mainly used for archiving test session error groups.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupPatch"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-sessions/trigger":{"post":{"summary":"Trigger a new test session","operationId":"postV1TestsessionsTrigger","description":"Starts a tests session with checks matching the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the test session to complete. Use the `GET /v1/test-sessions/{testSessionId}/completion` or `GET /v1/test-sessions/{testSessionId}` endpoints to track progress if needed.\n\nTest sessions do not produce alerts.\n\nEquivalent to the `npx checkly trigger` command of the Checkly CLI.","tags":["Test sessions","Triggers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerTestSessionRequestPayload"}}}},"responses":{"201":{"description":"Details of the new test session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerTestSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Returned when there are no matching checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoMatchingChecksFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-sessions/{testSessionId}":{"get":{"summary":"Retrieve a test session","operationId":"getV1TestsessionsTestsessionid","description":"Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress.","parameters":[{"name":"testSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the test session.","x-format":{"guid":true}},"description":"The unique identifier of the test session.","required":true}],"tags":["Test sessions"],"responses":{"200":{"description":"The current state of the test session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneTestSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such test session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionNotFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-sessions/{testSessionId}/completion":{"get":{"summary":"Await the completion of a test session","operationId":"getV1TestsessionsTestsessionidCompletion","description":"Call this endpoint to await the completion of a test session. A successful response code will be returned once the test session reaches its final state (i.e. when it passes or fails).\n\nIf the test session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/test-sessions/{testSessionId}` endpoint's response for a completed test session.","parameters":[{"name":"testSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the test session.","x-format":{"guid":true}},"description":"The unique identifier of the test session.","required":true},{"name":"maxWaitSeconds","in":"query","schema":{"type":"number","description":"The maximum time to wait for completion, in seconds.","example":30,"minimum":1,"maximum":30},"description":"The maximum time to wait for completion, in seconds."}],"tags":["Test sessions"],"responses":{"200":{"description":"Returned when the test session has finished running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitTestSessionCompletionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such test session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionNotFoundErrorResponse"}}}},"408":{"description":"The test session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitTestSessionCompletionTryAgainResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/triggers/check-groups/{groupId}":{"delete":{"summary":"Delete the check group trigger","operationId":"deleteV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Deletes the check groups trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"get":{"summary":"Get the check group trigger","operationId":"getV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Finds the check group trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"post":{"summary":"Create the check group trigger","operationId":"postV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Creates the check group trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/triggers/checks/{checkId}":{"delete":{"summary":"Delete the check trigger","operationId":"deleteV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Deletes the check trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"get":{"summary":"Get the check trigger","operationId":"getV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Finds the check trigger.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"post":{"summary":"Create the check trigger","operationId":"postV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Creates the check trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/variables":{"get":{"summary":"List all environment variables","operationId":"getV1Variables","description":"Lists all current environment variables in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Environment variables"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model258"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an environment variable","operationId":"postV1Variables","description":"Creates a new environment variable.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Environment variables"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/variables/{key}":{"delete":{"summary":"Delete an environment variable","operationId":"deleteV1VariablesKey","description":"Permanently removes an environment variable. Uses the \"key\" field as the ID for deletion.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an environment variable","operationId":"getV1VariablesKey","description":"Show details of a specific environment variable. Uses the \"key\" field for selection.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariableGet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an environment variable","operationId":"putV1VariablesKey","description":"Updates an environment variable. Uses the \"key\" field as the ID for updating. Only updates value, locked, and secret properties. Once a value is set to secret, it cannot be unset.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-groups":{"post":{"summary":"Create a check group (V2)","operationId":"postV2Checkgroups","description":"Creates a new check group. You can add checks to the group by setting the \"groupId\" property of individual checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Check groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCreateOrUpdateV2"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-groups/{id}":{"put":{"summary":"Update a check group (V2)","operationId":"putV2CheckgroupsId","description":"Updates a check group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Check groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCreateOrUpdateV2"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-results/{checkId}":{"get":{"summary":"Lists all check results","operationId":"getV2CheckresultsCheckid","description":"Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However, we keep the rolled up results for an indefinite period. +**Rate-limiting is applied to this endpoint, you can send 300 requests per day at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago."},"description":"Select metrics beginning with this UNIX timestamp. Must be less than 15 days ago.","required":true},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Select metrics up to this UNIX timestamp."},"description":"Select metrics up to this UNIX timestamp.","required":true}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsMetricsHistoryResponseSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/reporting":{"get":{"summary":"Generates a report with aggregate statistics for checks and check groups.","operationId":"getV1Reporting","description":"Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hrs","enum":["last24Hrs","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"filterByTags","in":"query","schema":{"type":"array","description":"Use tags to filter the checks you want to see in your report.","example":["production"],"x-constraint":{"single":true},"items":{"type":"string"}},"description":"Use tags to filter the checks you want to see in your report.","style":"form","explode":true},{"name":"deactivated","in":"query","schema":{"type":"boolean","description":"Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned.","default":null,"nullable":true},"description":"Filter checks by activated status. When set to true, only deactivated checks are returned. When set to false, only activated checks are returned. When omitted, all checks are returned."}],"tags":["Reporting"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ReportingList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/error-groups/{errorGroupId}":{"post":{"summary":"Generate a Root Cause Analysis for a check error group","operationId":"postV1RootcauseanalysesErrorgroupsErrorgroupid","description":"Asynchronously generates a root cause analysis for a specific check error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"errorGroupId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaErrorGroup"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model230"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/test-session-error-groups/{testSessionErrorGroupId}":{"post":{"summary":"Generate a Root Cause Analysis for a test session error group","operationId":"postV1RootcauseanalysesTestsessionerrorgroupsTestsessionerrorgroupid","description":"Asynchronously generates a root cause analysis for a specific test session error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"testSessionErrorGroupId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaErrorGroup"}}}},"responses":{"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PostRcaTestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/root-cause-analyses/{id}":{"get":{"summary":"Retrieve a Root Cause Analysis","operationId":"getV1RootcauseanalysesId","description":"Retrieves a specific root cause analysis. Use the `id` returned from either POST endpoint and poll until the response is HTTP 200. While the analysis is being generated the endpoint returns HTTP 202 with `{\"id\":\"\",\"status\":\"PENDING\"}`. A genuine HTTP 404 means the ID does not exist. Works for both check error group and test session error group analyses.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Rocky AI"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRca"}}}},"202":{"description":"Accepted","content":{"application/json":{"schema":{"$ref":"#/components/schemas/GetRcaPending"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/runtimes":{"get":{"summary":"Lists all supported runtimes","operationId":"getV1Runtimes","description":"Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Runtimes"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RuntimeList"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/runtimes/{id}":{"get":{"summary":"Shows details for one specific runtime","operationId":"getV1RuntimesId","description":"Shows the details of all included NPM packages and their version for one specific runtime","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string"},"required":true}],"tags":["Runtimes"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Runtime"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/snippets":{"get":{"summary":"List all snippets","operationId":"getV1Snippets","description":"Lists all current snippets in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Snippets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a snippet","operationId":"postV1Snippets","description":"Creates a new snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Snippets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/snippets/{id}":{"delete":{"summary":"Delete a snippet","operationId":"deleteV1SnippetsId","description":"Permanently removes a snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a snippet","operationId":"getV1SnippetsId","description":"Show details of a specific snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a snippet","operationId":"putV1SnippetsId","description":"Updates a snippet.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Snippets"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SnippetCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Snippet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips":{"get":{"summary":"Lists all source IPs for check runs","operationId":"getV1Staticips","description":"Lists all source IPs for check runs as a single JSON array.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips-by-region":{"get":{"summary":"Lists all source IPs for check runs","operationId":"getV1Staticipsbyregion","description":"Lists all source IPs for check runs as object with regions as keys and an array of IPs as value.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ips.txt":{"get":{"summary":"Lists all source IPs for check runs as txt file","operationId":"getV1Staticipstxt","description":"Lists all IPs for check runs as a TXT file. Each line has one IP.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s":{"get":{"summary":"Lists all source IPv6s for check runs","operationId":"getV1Staticipv6s","description":"Lists all source IPv6s for check runs as a single JSON array.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s-by-region":{"get":{"summary":"Lists all source IPv6s for check runs","operationId":"getV1Staticipv6sbyregion","description":"Lists all source IPs for check runs as an object with regions as keys and an Ipv6 as value.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/static-ipv6s.txt":{"get":{"summary":"Lists all source IPv6s for check runs as a txt file","operationId":"getV1Staticipv6stxt","description":"Lists all IPv6s for check runs as a TXT file. Each line has one IP.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Static IPs"],"responses":{"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages":{"get":{"summary":"Retrieve all status pages.","operationId":"getV1Statuspages","description":"Get all status pages for an account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}}],"tags":["Status Pages"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPagesV2PaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a new status page.","operationId":"postV1Statuspages","description":"Create a new status page with its related services and cards.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Pages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2PublicApiUpdate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents":{"get":{"summary":"Retrieve the latest incidents with pagination.","operationId":"getV1StatuspagesIncidents","description":"Get the latest 100 incidents for all services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentsPaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a new incident.","operationId":"postV1StatuspagesIncidents","description":"Creates a new incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateStatusPageV2Incident"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}":{"delete":{"summary":"Delete an incident.","operationId":"deleteV1StatuspagesIncidentsIncidentid","description":"Permanently removes an incident and all its updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident by id.","operationId":"getV1StatuspagesIncidentsIncidentid","description":"Get incident details including incident history and affected services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing incident.","operationId":"putV1StatuspagesIncidentsIncidentid","description":"Updates an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentCommon"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Incident"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}/incident-updates":{"get":{"summary":"Retrieve the 100 latest incident updates of a specific incident.","operationId":"getV1StatuspagesIncidentsIncidentidIncidentupdates","description":"Lists all updates for a specific incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model239"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Add a new incident update to a specific incident.","operationId":"postV1StatuspagesIncidentsIncidentidIncidentupdates","description":"Creates a new update for an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}":{"delete":{"summary":"Delete an incident update.","operationId":"deleteV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Permanently removes an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident update by id.","operationId":"getV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Shows details of a specific incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing incident update.","operationId":"putV1StatuspagesIncidentsIncidentidIncidentupdatesIncidentupdateid","description":"Modifies an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentUpdateId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/services":{"get":{"summary":"Get all services","operationId":"getV1StatuspagesServices","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","default":20,"minimum":1,"maximum":100}},{"name":"nextId","in":"query","schema":{"type":"string"}},{"name":"paginated","in":"query","schema":{"type":"boolean","default":true}}],"tags":["Status Page Services"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ServicesPaginatedResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a service","operationId":"postV1StatuspagesServices","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Status Page Services"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateService"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/services/{serviceId}":{"delete":{"summary":"Delete a service","operationId":"deleteV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Get a single service","operationId":"getV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a service","operationId":"putV1StatuspagesServicesServiceid","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"serviceId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Page Services"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateOrUpdateService"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2Service"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}":{"delete":{"summary":"Delete a status page.","operationId":"deleteV1StatuspagesStatuspageid","description":"Delete a status page.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"responses":{"204":{"description":"No Content","content":{"application/json":{"schema":{"type":"string"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a single status page by id.","operationId":"getV1StatuspagesStatuspageid","description":"Get status page data, including cards and services.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an existing status page.","operationId":"putV1StatuspagesStatuspageid","description":"Update a status page with its related services and cards.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2PublicApiUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/StatusPageV2WithId"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions":{"get":{"summary":"Get all subscriptions for a specific status page","operationId":"getV1StatuspagesStatuspageidSubscriptions","description":"Get all subscriptions for a specific status page","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"responses":{"200":{"description":"The list of subscriptions for the status page.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SubscriptionsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions/bulk":{"post":{"summary":"Bulk create subscriptions for a specific status page","operationId":"postV1StatuspagesStatuspageidSubscriptionsBulk","description":"Bulk create subscriptions for a specific status page.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateSubscriptionsPayload"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/BulkCreateSubscriptionsResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}":{"delete":{"summary":"Delete a subscription belonging to a specific status page","operationId":"deleteV1StatuspagesStatuspageidSubscriptionsSubscriptionid","description":"Delete a subscription belonging to a specific status page using the subscription id","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"statusPageId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"subscriptionId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Status Pages","Subscriptions"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups":{"get":{"summary":"List all test session error groups in your account.","operationId":"getV1Testsessionerrorgroups","description":"List all test session error groups in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups/projects/{projectId}":{"get":{"summary":"List all test session error groups for a specific project.","operationId":"getV1TestsessionerrorgroupsProjectsProjectid","description":"List all test session error groups for a specific project.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"projectId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-session-error-groups/{id}":{"get":{"summary":"Retrieve one test session error group.","operationId":"getV1TestsessionerrorgroupsId","description":"Retrieve one test session error group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"patch":{"summary":"Update a test session error group. Mainly used for archiving test session error groups.","operationId":"patchV1TestsessionerrorgroupsId","description":"Update a test session error group. Mainly used for archiving test session error groups.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Test Session Error Groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroupPatch"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/test-sessions/trigger":{"post":{"summary":"Trigger a new test session","operationId":"postV1TestsessionsTrigger","description":"Starts a tests session with checks matching the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the test session to complete. Use the `GET /v1/test-sessions/{testSessionId}/completion` or `GET /v1/test-sessions/{testSessionId}` endpoints to track progress if needed.\n\nTest sessions do not produce alerts.\n\nEquivalent to the `npx checkly trigger` command of the Checkly CLI.","tags":["Test sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerTestSessionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerTestSessionRequest"}}}}}},"/v1/test-sessions/{testSessionId}":{"get":{"summary":"Retrieve a test session","operationId":"getV1TestsessionsTestsessionid","description":"Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress.","tags":["Test sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneTestSessionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Test session ID."},"required":true,"description":"Test session ID.","name":"testSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/test-sessions/{testSessionId}/completion":{"get":{"summary":"Await the completion of a test session","operationId":"getV1TestsessionsTestsessionidCompletion","description":"Call this endpoint to await the completion of a test session. A successful response code will be returned once the test session reaches its final state (i.e. when it passes or fails).\n\nIf the test session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/test-sessions/{testSessionId}` endpoint's response for a completed test session.","tags":["Test sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitTestSessionCompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Test session ID."},"required":true,"description":"Test session ID.","name":"testSessionId","in":"path"},{"schema":{"type":"number","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/triggers/check-groups/{groupId}":{"delete":{"summary":"Delete the check group trigger","operationId":"deleteV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Deletes the check groups trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"get":{"summary":"Get the check group trigger","operationId":"getV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Finds the check group trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"post":{"summary":"Create the check group trigger","operationId":"postV1TriggersCheckgroupsGroupid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Creates the check group trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/triggers/checks/{checkId}":{"delete":{"summary":"Delete the check trigger","operationId":"deleteV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Deletes the check trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"get":{"summary":"Get the check trigger","operationId":"getV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Finds the check trigger.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true},"post":{"summary":"Create the check trigger","operationId":"postV1TriggersChecksCheckid","description":"**[DEPRECATED]** This endpoint will be removed soon. Please use the [Checkly CLI](https://www.checklyhq.com/docs/cli) to test and trigger checks. Creates the check trigger","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTrigger"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/variables":{"get":{"summary":"List all environment variables","operationId":"getV1Variables","description":"Lists all current environment variables in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Environment variables"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model247"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an environment variable","operationId":"postV1Variables","description":"Creates a new environment variable.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Environment variables"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/variables/{key}":{"delete":{"summary":"Delete an environment variable","operationId":"deleteV1VariablesKey","description":"Permanently removes an environment variable. Uses the \"key\" field as the ID for deletion.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an environment variable","operationId":"getV1VariablesKey","description":"Show details of a specific environment variable. Uses the \"key\" field for selection.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariableGet"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an environment variable","operationId":"putV1VariablesKey","description":"Updates an environment variable. Uses the \"key\" field as the ID for updating. Only updates value, locked, and secret properties. Once a value is set to secret, it cannot be unset.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"key","in":"path","schema":{"type":"string"},"required":true}],"tags":["Environment variables"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EnvironmentVariable"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-groups":{"post":{"summary":"Create a check group (V2)","operationId":"postV2Checkgroups","description":"Creates a new check group. You can add checks to the group by setting the \"groupId\" property of individual checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Check groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCreateOrUpdateV2"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-groups/{id}":{"put":{"summary":"Update a check group (V2)","operationId":"putV2CheckgroupsId","description":"Updates a check group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Check groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCreateOrUpdateV2"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-results/{checkId}":{"get":{"summary":"Lists all check results","operationId":"getV2CheckresultsCheckid","description":"Lists the full, raw check results for a specific check. We keep raw results for 30 days. After 30 days they are erased. However, we keep the rolled up results for an indefinite period. You can filter by check type and result type to narrow down the list. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. -**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}},"x-alt-definitions":{"SequenceIds":{"type":"array","description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences.","minItems":1,"items":{"type":"string","description":"A UUID v4 identifier.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","x-format":{"guid":true}}},"CancelCheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The ID of the check session to cancel.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","x-format":{"guid":true}},"sequenceId":{"$ref":"#/x-alt-definitions/SequenceIds"}},"required":["checkSessionId"]},"Model1":{"type":"array","description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress results.","minItems":1,"items":{"type":"string","description":"A UUID v4 identifier.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","x-format":{"guid":true}}},"CancelTestSession":{"type":"object","properties":{"testSessionId":{"type":"string","description":"The ID of the test session to cancel.","example":"a1b2c3d4-e5f6-7890-abcd-ef1234567890","x-format":{"guid":true}},"sequenceId":{"$ref":"#/x-alt-definitions/Model1"}},"required":["testSessionId"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/x-alt-definitions/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/x-alt-definitions/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/x-alt-definitions/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]}}} \ No newline at end of file +**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v2/check-sessions/{checkSessionId}/completion` or `GET /v2/check-sessions/{checkSessionId}` endpoints to track progress.\n\nUse `POST /v1/cancel` to cancel an in-progress check session.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v2/check-sessions/{checkSessionId}` endpoint's response for a completed check session.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}}} \ No newline at end of file From b0032280287a9d281815dd67e8532530f29663c6 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 10:48:22 +0200 Subject: [PATCH 08/13] docs: split v1/cancel into per-session cancel endpoints [RED-511] The public API replaced POST /v1/cancel with two path-scoped endpoints: POST /v1/check-sessions/{checkSessionId}/cancel and POST /v1/test-sessions/{testSessionId}/cancel. - openapi.json: swap the cancel path and schemas to match the live spec; update v2 check-session descriptions that cross-referenced /v1/cancel - Split the reference page into cancel-a-check-session and cancel-a-test-session, filed under the Check Sessions and Test Sessions nav groups; drop the standalone Cancel group - cancellation.mdx: update API tab, curl examples, and versioning notes - style.css: add a dark-mode rule so keys are visible Co-Authored-By: Claude Opus 4.7 (1M context) --- api-reference/cancel/cancel-a-session.mdx | 14 -------------- .../check-sessions/cancel-a-check-session.mdx | 9 +++++++++ api-reference/openapi.json | 6 +++--- .../test-sessions/cancel-a-test-session.mdx | 9 +++++++++ concepts/cancellation.mdx | 14 +++++++------- docs.json | 15 ++++++++------- style.css | 6 ++++++ 7 files changed, 42 insertions(+), 31 deletions(-) delete mode 100644 api-reference/cancel/cancel-a-session.mdx create mode 100644 api-reference/check-sessions/cancel-a-check-session.mdx create mode 100644 api-reference/test-sessions/cancel-a-test-session.mdx diff --git a/api-reference/cancel/cancel-a-session.mdx b/api-reference/cancel/cancel-a-session.mdx deleted file mode 100644 index 5ee7e40e..00000000 --- a/api-reference/cancel/cancel-a-session.mdx +++ /dev/null @@ -1,14 +0,0 @@ ---- -openapi: post /v1/cancel -title: Cancel a check or test session -sidebarTitle: Cancel a session ---- - -Stops an in-progress check session or test session by ID. The request body discriminates by which ID you pass: - -- Pass a `checkSessionId` to cancel a [check session](/api-reference/check-sessions/retrieve-a-check-session-v2) (UI "Schedule now" or `checkly deploy`). -- Pass a `testSessionId` to cancel a [test session](/detect/testing/overview) (`checkly test`, `checkly trigger`, or `checkly pw-test`). - -Optionally pass `sequenceId` (a single UUID or an array) to cancel only specific runs within the session. Omit it to cancel every in-progress run. - -Only Playwright Check Suite runs are cancellable. If a test session also contains URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs, those continue executing until they finish normally. See [Cancellation](/concepts/cancellation) for the full flow, the effect on alerts and metrics, and how the `CANCELLED` status and `isCancelled` flag surface in responses. diff --git a/api-reference/check-sessions/cancel-a-check-session.mdx b/api-reference/check-sessions/cancel-a-check-session.mdx new file mode 100644 index 00000000..a7d48dad --- /dev/null +++ b/api-reference/check-sessions/cancel-a-check-session.mdx @@ -0,0 +1,9 @@ +--- +openapi: post /v1/check-sessions/{checkSessionId}/cancel +title: Cancel a check session +sidebarTitle: Cancel a check session +--- + +Check sessions are started by the UI "Schedule now" button and `checkly deploy`. + +See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status. diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 8827d554..5e34eb3f 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -6,7 +6,7 @@ keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set **Authorization** header while using cURL: `curl -H \"Authorization: Bearer [apiKey]\" \"X-Checkly-Account: [accountId]\"` -"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"TriggerTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","minLength":1,"description":"A short description for the testing environment."},"repoUrl":{"type":"string","nullable":true},"commitId":{"type":"string","nullable":true},"commitOwner":{"type":"string","nullable":true},"commitMessage":{"type":"string","nullable":true},"branchName":{"type":"string","nullable":true}}},"TestSessionResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","format":"uuid"},"testSessionResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","nullable":true,"format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups associated with this result."},"resultType":{"type":"string","enum":["FINAL","ATTEMPT","PENDING"]},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"}},"required":["testSessionResultId","testSessionResultLink","checkType","errorGroupIds","status","hasErrors","hasFailures","isDegraded","aborted"]},"TriggerTestSessionRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the test session."},"runLocation":{"type":"string","minLength":1,"description":"A public region code or private location slug name."},"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."},"allowDeactivated":{"type":"boolean","default":false,"description":"Allow deactivated checks to match."}}},"environmentVariables":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionEnvironmentVariable"},"maxItems":50},"retryStrategy":{"anyOf":[{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["FIXED","LINEAR","EXPONENTIAL"]},"maxRetries":{"type":"number","minimum":1,"maximum":10,"default":2},"maxDurationSeconds":{"type":"number","minimum":0,"maximum":600,"default":600}},"required":["type"]},{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["SINGLE_RETRY"]}},"required":["type"]},{"nullable":true}]},"refreshCache":{"type":"boolean","default":false,"description":"Skip existing caches and install dependencies from scratch."},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"TestSessionEnvironmentVariable":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"nullable":true},"secret":{"type":"boolean","enum":[true]}},"required":["key","value","secret"]},{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"type":"string","nullable":true,"minLength":1},"secret":{"type":"boolean","enum":[false],"default":false}},"required":["key","value"]}]},"CancelRequest":{"anyOf":[{"$ref":"#/components/schemas/CancelCheckSession"},{"$ref":"#/components/schemas/CancelTestSession"}]},"CancelCheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid","description":"The ID of the check session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["checkSessionId"],"additionalProperties":false},"SequenceIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."},"CancelTestSession":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid","description":"The ID of the test session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["testSessionId"],"additionalProperties":false},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AwaitTestSessionCompletionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","stoppedAt","timeElapsed"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"FindOneTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":null,"nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":null,"nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":null,"nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":null,"nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.773Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.868Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model247":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model248":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model249":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model248"}},"Model250":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model251":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model252":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model253":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model254":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model255":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model253"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model254"},"reminders":{"$ref":"#/components/schemas/Model255"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model249"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model250"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model251"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model252"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. +"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"TriggerTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","minLength":1,"description":"A short description for the testing environment."},"repoUrl":{"type":"string","nullable":true},"commitId":{"type":"string","nullable":true},"commitOwner":{"type":"string","nullable":true},"commitMessage":{"type":"string","nullable":true},"branchName":{"type":"string","nullable":true}}},"TestSessionResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","format":"uuid"},"testSessionResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","nullable":true,"format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups associated with this result."},"resultType":{"type":"string","enum":["FINAL","ATTEMPT","PENDING"]},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"}},"required":["testSessionResultId","testSessionResultLink","checkType","errorGroupIds","status","hasErrors","hasFailures","isDegraded","aborted"]},"TriggerTestSessionRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the test session."},"runLocation":{"type":"string","minLength":1,"description":"A public region code or private location slug name."},"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."},"allowDeactivated":{"type":"boolean","default":false,"description":"Allow deactivated checks to match."}}},"environmentVariables":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionEnvironmentVariable"},"maxItems":50},"retryStrategy":{"anyOf":[{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["FIXED","LINEAR","EXPONENTIAL"]},"maxRetries":{"type":"number","minimum":1,"maximum":10,"default":2},"maxDurationSeconds":{"type":"number","minimum":0,"maximum":600,"default":600}},"required":["type"]},{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["SINGLE_RETRY"]}},"required":["type"]},{"nullable":true}]},"refreshCache":{"type":"boolean","default":false,"description":"Skip existing caches and install dependencies from scratch."},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"TestSessionEnvironmentVariable":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"nullable":true},"secret":{"type":"boolean","enum":[true]}},"required":["key","value","secret"]},{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"type":"string","nullable":true,"minLength":1},"secret":{"type":"boolean","enum":[false],"default":false}},"required":["key","value"]}]},"CheckSessionsV1CancelRequest":{"type":"object","properties":{"sequenceId":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."}},"additionalProperties":false},"TestSessionsV1CancelRequest":{"type":"object","properties":{"sequenceId":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."}},"additionalProperties":false},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AwaitTestSessionCompletionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","stoppedAt","timeElapsed"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"FindOneTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":null,"nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":null,"nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":null,"nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":null,"nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.773Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.868Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model247":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model248":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model249":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model248"}},"Model250":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model251":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model252":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model253":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model254":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model255":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model253"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model254"},"reminders":{"$ref":"#/components/schemas/Model255"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model249"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model250"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model251"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model252"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 24-hour timeframe. If the `from` and `to` params are set, they must be at most 24 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 24 hours earlier. If only the `to` param is set we will set `from` to be 24 hours earlier. If only the `from` param is set we will consider the `to` param to be 24 hours later. @@ -26,7 +26,7 @@ Currently only `quickRange` is supported for time filtering. Arbitrary `from`/`t **Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["total","dns","connection","data","availability","retries","total_avg","total_max","total_median","total_min","total_p50","total_p90","total_p95","total_p99","total_stddev","total_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","connection_avg","connection_max","connection_median","connection_min","connection_p50","connection_p90","connection_p95","connection_p99","connection_stddev","connection_sum","data_avg","data_max","data_median","data_min","data_p50","data_p90","data_p95","data_p99","data_stddev","data_sum"]}},"description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model35"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/analytics/url-monitors/{id}":{"get":{"summary":"URL Monitors","operationId":"getV1AnalyticsUrlmonitorsId","description":"Fetch detailed availability metrics and aggregated or non-aggregated API Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the DNS phases of your API check together with the availability percentage for any time range. -**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/cancel":{"post":{"summary":"Cancel a check run, check session, test run, or test session","operationId":"postV1Cancel","description":"Cancels in-progress Playwright Check Suite runs. The request body must reference exactly one of `checkSessionId` or `testSessionId`. A `checkSessionId` is obtained from `POST /v2/check-sessions/trigger`. Use the optional `sequenceId` field to cancel only specific parallel runs within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. The response does not confirm whether the session was found or eligible — use `GET /v2/check-sessions/{checkSessionId}` to verify the resulting state.","tags":["cancel"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. +**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/check-sessions/{checkSessionId}/cancel":{"post":{"summary":"Cancel a check session","operationId":"postV1ChecksessionsChecksessionidCancel","description":"Cancels in-progress Playwright Check Suite runs within the specified check session. Use the optional `sequenceId` field in the request body to cancel only specific parallel runs within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. Returns `404 Not Found` if the check session does not exist.","tags":["Check sessions"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV1CancelRequest"}}}}}},"/v1/test-sessions/{testSessionId}/cancel":{"post":{"summary":"Cancel a test session","operationId":"postV1TestsessionsTestsessionidCancel","description":"Cancels in-progress Playwright runs within the specified test session. Use the optional `sequenceId` field in the request body to cancel only specific results within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. Returns `404 Not Found` if the test session does not exist.","tags":["Test sessions"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Test session ID."},"required":true,"description":"Test session ID.","name":"testSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionsV1CancelRequest"}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most 6 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 6 hours earlier. If only the `to` param is set we will set `from` to be 6 hours earlier. If only the `from` param is set we will consider the `to` param to be 6 hours later.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."}],"tags":["Check alerts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAlertList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-alerts/{checkId}":{"get":{"summary":"List alerts for a specific check","operationId":"getV1CheckalertsCheckid","description":"Lists all the alerts for a specific check. @@ -45,4 +45,4 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to` You can filter by check type and result type to narrow down the list. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. -**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v2/check-sessions/{checkSessionId}/completion` or `GET /v2/check-sessions/{checkSessionId}` endpoints to track progress.\n\nUse `POST /v1/cancel` to cancel an in-progress check session.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v2/check-sessions/{checkSessionId}` endpoint's response for a completed check session.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}}} \ No newline at end of file +**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v2/check-sessions/{checkSessionId}/completion` or `GET /v2/check-sessions/{checkSessionId}` endpoints to track progress.\n\nUse `POST /v1/check-sessions/{checkSessionId}/cancel` to cancel an in-progress check session.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/check-sessions/{checkSessionId}/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v2/check-sessions/{checkSessionId}` endpoint's response for a completed check session.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/check-sessions/{checkSessionId}/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}}} \ No newline at end of file diff --git a/api-reference/test-sessions/cancel-a-test-session.mdx b/api-reference/test-sessions/cancel-a-test-session.mdx new file mode 100644 index 00000000..c9a62db1 --- /dev/null +++ b/api-reference/test-sessions/cancel-a-test-session.mdx @@ -0,0 +1,9 @@ +--- +openapi: post /v1/test-sessions/{testSessionId}/cancel +title: Cancel a test session +sidebarTitle: Cancel a test session +--- + +Test sessions are created by `checkly test --record`, `checkly trigger --record`, and `checkly pw-test`. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. + +See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status. diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index dd4061af..2c451fd7 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -26,22 +26,22 @@ On a check session or test session page, click **Cancel session** in the header -Send a `POST` request to [`/v1/cancel`](/api-reference/cancel/cancel-a-session) with either a `checkSessionId` or a `testSessionId`. Pass an optional `sequenceId` (or array) to cancel only specific runs within the session. +Send a `POST` request to the cancel endpoint for the session type: [`/v1/check-sessions/{checkSessionId}/cancel`](/api-reference/check-sessions/cancel-a-check-session) or [`/v1/test-sessions/{testSessionId}/cancel`](/api-reference/test-sessions/cancel-a-test-session). The session ID goes in the path. Pass an optional `sequenceId` array in the body to cancel only specific runs within the session; send `{}` to cancel everything still running. ```bash Cancel a whole check session -curl -X POST https://api.checklyhq.com/v1/cancel \ +curl -X POST https://api.checklyhq.com/v1/check-sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel \ -H "Authorization: Bearer $CHECKLY_API_KEY" \ -H "X-Checkly-Account: $CHECKLY_ACCOUNT_ID" \ -H "Content-Type: application/json" \ - -d '{"checkSessionId": "a1b2c3d4-e5f6-7890-abcd-ef1234567890"}' + -d '{}' ``` ```bash Cancel specific runs in a test session -curl -X POST https://api.checklyhq.com/v1/cancel \ +curl -X POST https://api.checklyhq.com/v1/test-sessions/a1b2c3d4-e5f6-7890-abcd-ef1234567890/cancel \ -H "Authorization: Bearer $CHECKLY_API_KEY" \ -H "X-Checkly-Account: $CHECKLY_ACCOUNT_ID" \ -H "Content-Type: application/json" \ - -d '{"testSessionId": "a1b2c3d4-...", "sequenceId": ["b2c3d4e5-..."]}' + -d '{"sequenceId": ["b2c3d4e5-f6a7-8901-bcde-f12345678901"]}' ``` @@ -92,8 +92,8 @@ Cancellation introduces two API additions: a new `CANCELLED` value on the check- [`GET /v1/check-results/{checkId}/{checkResultId}`](/api-reference/check-results/retrieve-a-check-result) and the list endpoints include `isCancelled` on every result. - -[`POST /v1/cancel`](/api-reference/cancel/cancel-a-session) is the action endpoint itself. It accepts either a `checkSessionId` or a `testSessionId` in the body, so a single endpoint covers both. + +[`POST /v1/check-sessions/{checkSessionId}/cancel`](/api-reference/check-sessions/cancel-a-check-session) and [`POST /v1/test-sessions/{testSessionId}/cancel`](/api-reference/test-sessions/cancel-a-test-session) are the action endpoints. Each takes the session ID in the path and an optional `sequenceId` array in the body. If you build automation against check sessions and need to distinguish cancelled sessions from genuine timeouts at the session level, switch to the v2 endpoints. Otherwise, the `isCancelled` flag on per-result objects is available in both versions. diff --git a/docs.json b/docs.json index a73edaa9..112103ef 100644 --- a/docs.json +++ b/docs.json @@ -738,13 +738,8 @@ "api-reference/check-sessions/retrieve-a-check-session", "api-reference/check-sessions/retrieve-a-check-session-v2", "api-reference/check-sessions/await-the-completion-of-a-check-session", - "api-reference/check-sessions/await-the-completion-of-a-check-session-v2" - ] - }, - { - "group": "Cancel", - "pages": [ - "api-reference/cancel/cancel-a-session" + "api-reference/check-sessions/await-the-completion-of-a-check-session-v2", + "api-reference/check-sessions/cancel-a-check-session" ] }, { @@ -937,6 +932,12 @@ "api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page" ] }, + { + "group": "Test Sessions", + "pages": [ + "api-reference/test-sessions/cancel-a-test-session" + ] + }, { "group": "Test Session Error Groups", "pages": [ diff --git a/style.css b/style.css index 04a16201..ef124f56 100644 --- a/style.css +++ b/style.css @@ -30,3 +30,9 @@ tr { font-weight: 700; font-size: 1.15rem; } + +.dark kbd { + background-color: rgba(255, 255, 255, 0.08); + border-color: rgba(255, 255, 255, 0.2); + color: #e6e6e6; +} From 12ef28364a42ea8084a0d84dfec760515fd8da4d Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 11:04:28 +0200 Subject: [PATCH 09/13] docs: default --record to true on test and trigger commands [RED-511] checkly-cli #1306 makes `checkly test` and `checkly trigger` record a test session by default (opt out with --no-record), matching pw-test. - test/trigger reference pages: --record -> --[no-]record, note that recording defaults to enabled since CLI v8.0.0 - Fill in CLI v8.0.0 for the cancellation availability notes across test, trigger, and pw-test (replacing the vX.X placeholders) - cancellation.mdx and cancel-a-test-session.mdx: test sessions are created by checkly test/trigger/pw-test, which all record by default Co-Authored-By: Claude Opus 4.7 (1M context) --- .../test-sessions/cancel-a-test-session.mdx | 2 +- cli/checkly-pw-test.mdx | 3 +- cli/checkly-test.mdx | 32 ++++++++-------- cli/checkly-trigger.mdx | 38 ++++++++++--------- concepts/cancellation.mdx | 6 ++- 5 files changed, 43 insertions(+), 38 deletions(-) diff --git a/api-reference/test-sessions/cancel-a-test-session.mdx b/api-reference/test-sessions/cancel-a-test-session.mdx index c9a62db1..27121c3b 100644 --- a/api-reference/test-sessions/cancel-a-test-session.mdx +++ b/api-reference/test-sessions/cancel-a-test-session.mdx @@ -4,6 +4,6 @@ title: Cancel a test session sidebarTitle: Cancel a test session --- -Test sessions are created by `checkly test --record`, `checkly trigger --record`, and `checkly pw-test`. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. +Test sessions are created by `checkly test`, `checkly trigger`, and `checkly pw-test`, which record by default. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status. diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index 0b4142e0..dc9d0bab 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -447,8 +447,7 @@ npx checkly pw-test -- test.spec.ts ## Cancelling a run -{/* TODO: confirm CLI version that ships pw-test Ctrl+C handling and fill in the Note below. */} -Available in CLI vX.X+. +Available in CLI v8.0.0+. Cancellation is available only for recorded test sessions. `pw-test` records by default, so its runs can be cancelled unless you pass `--no-record`. diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index 3b08cad8..268ff171 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -28,12 +28,12 @@ npx checkly test [arguments] [options] | `--list` | - | List all checks but don't run them. | | `--location, -l` | - | The location to run the checks at. | | `--private-location` | - | The private location to run checks at. | -| `--record` | - | Record test session results in Checkly with full logs, traces and videos. | +| `--[no-]record` | - | Record test session results in Checkly with full logs, traces and videos. Records by default since CLI v8.0.0. | | `--refresh-cache` | - | Force a fresh install of dependencies and update the cached version. | | `--reporter, -r` | - | One or more custom reporters for the test output. Supports comma-separated values and repeated flags. | | `--retries` | - | How many times to retry a failing test run. | | `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. | -| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. | +| `--test-session-name, -n` | - | A name to use when recording results in Checkly. | | `--timeout` | - | A timeout (in seconds) to wait for checks to complete. | | `--update-snapshots, -u` | - | Update any snapshots using the actual result of this test run. | | `--verbose, -v` | - | Always show the full logs of the checks. | @@ -61,7 +61,7 @@ Skip the cancellation prompt. By default, pressing Ctrl+C **Usage:** ```bash Terminal -npx checkly test --record --detach +npx checkly test --detach ``` @@ -241,15 +241,18 @@ npx checkly test -r github -r json - + -Record test results in Checkly as [a test session](/detect/testing/overview) with full logs, traces and videos. +Record test results in Checkly as [a test session](/detect/testing/overview) with full logs, traces and videos. Recording is enabled by default; use `--no-record` to disable it. + +Recording defaults to enabled since CLI v8.0.0. In earlier versions, recording was opt-in via `--record`. **Usage:** ```bash Terminal -npx checkly test --record -npx checkly test --record --test-session-name="CI Build #123" +npx checkly test +npx checkly test --no-record +npx checkly test --test-session-name="CI Build #123" ``` @@ -293,13 +296,13 @@ npx checkly test --retries 3 -A name to use when storing results in Checkly with `--record`. +A name to use when recording results in Checkly. **Usage:** ```bash Terminal -npx checkly test --record --test-session-name="Release v1.2.3" -npx checkly test --record -n="Nightly Test Run" +npx checkly test --test-session-name="Release v1.2.3" +npx checkly test -n="Nightly Test Run" ``` @@ -375,10 +378,10 @@ Dry run checks that have `product` and `api` in the file name: npx checkly test product api ``` -Record a test session in Checkly with git branch info, full logging, videos and traces: +Run checks without recording a test session: ```bash Terminal -npx checkly test --record +npx checkly test --no-record ``` Dry run all checks against a specific location: @@ -395,10 +398,9 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD ## Cancelling a run -{/* TODO: confirm CLI version that ships test Ctrl+C handling and fill in the Note below. */} -Available in CLI vX.X+. +Available in CLI v8.0.0+. -When you run with `--record`, pressing Ctrl+C opens a prompt to cancel the recorded test session. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. +`checkly test` records a test session by default, so pressing Ctrl+C opens a prompt to cancel it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 306cf2db..495014fe 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -27,12 +27,12 @@ npx checkly trigger [options] | `--fail-on-no-matching` | - | Exit with a failing status code when there are no matching tests. | | `--location, -l` | - | The location to run the checks at. | | `--private-location` | - | The private location to run checks at. | -| `--record` | - | Record test session results in Checkly with full logs, traces and videos. | +| `--[no-]record` | - | Record test session results in Checkly with full logs, traces and videos. Records by default since CLI v8.0.0. | | `--refresh-cache` | - | Force a fresh install of dependencies and update the cached version. | | `--reporter, -r` | - | One or more custom reporters for the test output. Supports comma-separated values and repeated flags. | | `--retries` | - | How many times to retry a check run. | | `--tags, -t` | - | Filter the checks to be run using a comma separated list of tags. | -| `--test-session-name, -n` | - | A name to use when storing results in Checkly with `--record`. | +| `--test-session-name, -n` | - | A name to use when recording results in Checkly. | | `--timeout` | - | A timeout (in seconds) to wait for checks to complete. | | `--verbose, -v` | - | Always show the full logs of the checks. | @@ -58,7 +58,7 @@ Skip the cancellation prompt. By default, pressing Ctrl+C **Usage:** ```bash Terminal -npx checkly trigger --record --detach +npx checkly trigger --detach ``` @@ -181,12 +181,12 @@ Tags are comma-separated within a single flag for AND logic, multiple flags for -A name to use when storing results in Checkly with `--record`. +A name to use when recording results in Checkly. **Usage:** ```bash Terminal -npx checkly trigger --record --test-session-name="Custom session name" +npx checkly trigger --test-session-name="Custom session name" ``` @@ -272,27 +272,30 @@ npx checkly trigger --no-fail-on-no-matching --tags optional-tag Enabled by default. Use `--no-fail-on-no-matching` to allow zero matches without failure. - + -Record check results in Checkly as a test session with full logs, traces and videos. +Record check results in Checkly as a test session with full logs, traces and videos. Recording is enabled by default; use `--no-record` to disable it. + +Recording defaults to enabled since CLI v8.0.0. In earlier versions, recording was opt-in via `--record`. **Usage:** ```bash Terminal -npx checkly trigger --record +npx checkly trigger +npx checkly trigger --no-record ``` **Examples:** ```bash Terminal -# Basic recording -npx checkly trigger --record - -# Record with custom name -npx checkly trigger --record --test-session-name "Deploy validation" +# Record with a custom session name +npx checkly trigger --test-session-name "Deploy validation" # Record specific checks -npx checkly trigger --record --tags critical +npx checkly trigger --tags critical + +# Run without recording +npx checkly trigger --no-record ``` Records provide full visibility including logs, traces, and videos for debugging failed checks. @@ -380,17 +383,16 @@ Default: 600 seconds (10 minutes). Adjust based on your longest-running checks. Run your deployed checks before promoting code to production: ```bash Terminal -npx checkly trigger --tags staging --record --test-session-name "Pre-prod validation" +npx checkly trigger --tags staging --test-session-name "Pre-prod validation" ``` If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration. ## Cancelling a run -{/* TODO: confirm CLI version that ships trigger Ctrl+C handling and fill in the Note below. */} -Available in CLI vX.X+. +Available in CLI v8.0.0+. -When you run with `--record`, pressing Ctrl+C opens a prompt to cancel the recorded test session. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. +`checkly trigger` records a test session by default, so pressing Ctrl+C opens a prompt to cancel it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index 2c451fd7..f1b0f904 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -12,7 +12,7 @@ You can cancel two kinds of sessions, and the behaviour differs: **Check sessions** — created by the UI "Schedule now" button and `checkly deploy`. A check session is one execution of a single Playwright Check Suite, fanned out across the locations you configured. Cancelling the session stops every in-progress run; cancelling a single run leaves the rest of the session going. -**Test sessions** — created by `checkly test --record`, `checkly trigger --record`, and `checkly pw-test` (which records by default). A test session can contain multiple checks of different types. Cancelling the test session stops only the Playwright Check Suite runs inside it; any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs in the same session continue until they finish normally. You can also cancel a single Playwright run within the session. +**Test sessions** — created by `checkly test`, `checkly trigger`, and `checkly pw-test`, which all record by default. A test session can contain multiple checks of different types. Cancelling the test session stops only the Playwright Check Suite runs inside it; any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs in the same session continue until they finish normally. You can also cancel a single Playwright run within the session. **Only Playwright Check Suite runs are cancellable.** Other check types cannot be cancelled, even when they appear inside a test session alongside Playwright runs. Scheduled runs are also excluded; cancellation is for user-initiated runs only. @@ -46,7 +46,9 @@ curl -X POST https://api.checklyhq.com/v1/test-sessions/a1b2c3d4-e5f6-7890-abcd- -Press Ctrl+C during a recorded test session run — `checkly pw-test` (records by default), `checkly test --record`, or `checkly trigger --record` — to open a cancellation prompt. +CLI cancellation is available in CLI v8.0.0+. + +Press Ctrl+C during a recorded test session run — `checkly test`, `checkly trigger`, and `checkly pw-test` all record by default — to open a cancellation prompt. See the [CLI reference](/cli/overview) for command-specific behavior. From 2c6949ea9169e48e33d9ce87345db5949325db90 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 11:10:17 +0200 Subject: [PATCH 10/13] docs: simplify test-session cancellation wording [RED-511] Co-Authored-By: Claude Opus 4.7 (1M context) --- api-reference/test-sessions/cancel-a-test-session.mdx | 2 +- cli/checkly-pw-test.mdx | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/api-reference/test-sessions/cancel-a-test-session.mdx b/api-reference/test-sessions/cancel-a-test-session.mdx index 27121c3b..cf6bd366 100644 --- a/api-reference/test-sessions/cancel-a-test-session.mdx +++ b/api-reference/test-sessions/cancel-a-test-session.mdx @@ -4,6 +4,6 @@ title: Cancel a test session sidebarTitle: Cancel a test session --- -Test sessions are created by `checkly test`, `checkly trigger`, and `checkly pw-test`, which record by default. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. +Test sessions are recorded with `checkly test`, `checkly trigger`, and `checkly pw-test`. Cancellation applies only to the session's Playwright Check Suite runs — any URL, API, Browser, Multistep, Heartbeat, TCP, DNS, or ICMP runs continue until they finish normally. See [Cancellation](/concepts/cancellation) for how cancelled runs affect alerts, metrics, and the `CANCELLED` session status. diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index dc9d0bab..baf3daaa 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -449,7 +449,7 @@ npx checkly pw-test -- test.spec.ts Available in CLI v8.0.0+. -Cancellation is available only for recorded test sessions. `pw-test` records by default, so its runs can be cancelled unless you pass `--no-record`. +Cancellation is available only for recorded test sessions. Press Ctrl+C during a `checkly pw-test` run to open a cancellation prompt. Pressing Ctrl+C a second time exits the CLI without waiting. Pass the `--detach` flag to skip the prompt entirely — Ctrl+C then exits immediately and the checks keep running in the cloud. From 3d14d1dd4c98be7dff7ccb7a9a6bbcdf4857beb3 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 11:16:13 +0200 Subject: [PATCH 11/13] docs: keep explicit --record in test/trigger examples [RED-511] Show the --record flag explicitly in example snippets so they work on pre-v8.0.0 CLIs where recording is opt-in. The --detach examples omit it, since --detach only exists in v8.0.0+ where --record is default. Co-Authored-By: Claude Opus 4.7 (1M context) --- cli/checkly-test.mdx | 12 ++++++------ cli/checkly-trigger.mdx | 10 +++++----- 2 files changed, 11 insertions(+), 11 deletions(-) diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index 268ff171..23a3807c 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -250,9 +250,9 @@ Record test results in Checkly as [a test session](/detect/testing/overview) wit **Usage:** ```bash Terminal -npx checkly test +npx checkly test --record npx checkly test --no-record -npx checkly test --test-session-name="CI Build #123" +npx checkly test --record --test-session-name="CI Build #123" ``` @@ -301,8 +301,8 @@ A name to use when recording results in Checkly. **Usage:** ```bash Terminal -npx checkly test --test-session-name="Release v1.2.3" -npx checkly test -n="Nightly Test Run" +npx checkly test --record --test-session-name="Release v1.2.3" +npx checkly test --record -n="Nightly Test Run" ``` @@ -378,10 +378,10 @@ Dry run checks that have `product` and `api` in the file name: npx checkly test product api ``` -Run checks without recording a test session: +Record a test session in Checkly with git branch info, full logging, videos and traces: ```bash Terminal -npx checkly test --no-record +npx checkly test --record ``` Dry run all checks against a specific location: diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 495014fe..9de0ac17 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -186,7 +186,7 @@ A name to use when recording results in Checkly. **Usage:** ```bash Terminal -npx checkly trigger --test-session-name="Custom session name" +npx checkly trigger --record --test-session-name="Custom session name" ``` @@ -281,7 +281,7 @@ Record check results in Checkly as a test session with full logs, traces and vid **Usage:** ```bash Terminal -npx checkly trigger +npx checkly trigger --record npx checkly trigger --no-record ``` @@ -289,10 +289,10 @@ npx checkly trigger --no-record ```bash Terminal # Record with a custom session name -npx checkly trigger --test-session-name "Deploy validation" +npx checkly trigger --record --test-session-name "Deploy validation" # Record specific checks -npx checkly trigger --tags critical +npx checkly trigger --record --tags critical # Run without recording npx checkly trigger --no-record @@ -383,7 +383,7 @@ Default: 600 seconds (10 minutes). Adjust based on your longest-running checks. Run your deployed checks before promoting code to production: ```bash Terminal -npx checkly trigger --tags staging --test-session-name "Pre-prod validation" +npx checkly trigger --tags staging --record --test-session-name "Pre-prod validation" ``` If your production deployment includes monitoring changes and updates, [use `npx checkly test`](/cli/checkly-test) to validate your preview environment with the updated monitoring configuration. From fba438b40bd3e9eabf30912bec9d7675508ca431 Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 14:36:44 +0200 Subject: [PATCH 12/13] =?UTF-8?q?docs:=20correct=20CLI=20cancellation=20be?= =?UTF-8?q?havior=20=E2=80=94=20no=20confirmation=20prompt=20[RED-511]?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit The shipped checkly-cli (PR #1292) cancels directly on Ctrl+C; the cancel-confirmation prompt was prototyped but never merged. Update the docs to match: first Ctrl+C cancels the session, the CLI keeps running to report results, a second Ctrl+C exits immediately, and --detach exits at once leaving checks running in the cloud. Co-Authored-By: Claude Opus 4.7 (1M context) --- cli/checkly-pw-test.mdx | 6 +++--- cli/checkly-test.mdx | 10 ++++++---- cli/checkly-trigger.mdx | 10 ++++++---- concepts/cancellation.mdx | 2 +- 4 files changed, 16 insertions(+), 12 deletions(-) diff --git a/cli/checkly-pw-test.mdx b/cli/checkly-pw-test.mdx index baf3daaa..9804991b 100644 --- a/cli/checkly-pw-test.mdx +++ b/cli/checkly-pw-test.mdx @@ -36,7 +36,7 @@ Define `checkly pw-test` specific options before the `--` separator: |--------|----------|-------------| | `--config` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | | `--create-check` | - | Create a Checkly check from the Playwright test. | -| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. | | `--env, -e` | - | Env vars to be passed to the test run. Default: [] | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--include, -i` | - | File patterns to include when bundling the test project (e.g., `"utils/**/*"`). Can be repeated. | @@ -128,7 +128,7 @@ const config = defineConfig({ -Skip the cancellation prompt. By default, pressing Ctrl+C during a `pw-test` run opens a prompt to cancel the recorded test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. +By default, pressing Ctrl+C during a `pw-test` run cancels the recorded test session. With `--detach`, Ctrl+C exits the CLI immediately instead, leaving the checks running in the cloud. **Usage:** @@ -451,7 +451,7 @@ npx checkly pw-test -- test.spec.ts Cancellation is available only for recorded test sessions. -Press Ctrl+C during a `checkly pw-test` run to open a cancellation prompt. Pressing Ctrl+C a second time exits the CLI without waiting. Pass the `--detach` flag to skip the prompt entirely — Ctrl+C then exits immediately and the checks keep running in the cloud. +Press Ctrl+C during a `checkly pw-test` run to cancel the test session. The CLI keeps running to report the cancelled results; press Ctrl+C again to exit immediately without waiting. Pass the `--detach` flag to keep the checks running in the cloud instead — Ctrl+C then exits the CLI immediately without cancelling. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/cli/checkly-test.mdx b/cli/checkly-test.mdx index 23a3807c..cf7bf61e 100644 --- a/cli/checkly-test.mdx +++ b/cli/checkly-test.mdx @@ -21,7 +21,7 @@ npx checkly test [arguments] [options] | Option | Required | Description | |--------|----------|-------------| | `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. | | `--env, -e` | - | Env vars to be passed to the test run. Can be used multiple times. | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--grep, -g` | - | Only run checks where the check name matches a regular expression. Default: `.*` | @@ -56,7 +56,7 @@ npx checkly test -c="./checkly.staging.config.ts" -Skip the cancellation prompt. By default, pressing Ctrl+C during a recorded run opens a prompt to cancel the test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. +By default, pressing Ctrl+C during a recorded run cancels the test session. With `--detach`, Ctrl+C exits the CLI immediately instead, leaving the checks running in the cloud. **Usage:** @@ -400,9 +400,11 @@ npx checkly test --env ENVIRONMENT_URL="https://preview.acme.com" --env PASSWORD Available in CLI v8.0.0+. -`checkly test` records a test session by default, so pressing Ctrl+C opens a prompt to cancel it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. +`checkly test` records a test session by default, so pressing Ctrl+C cancels it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. -Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. +The CLI keeps running after the first Ctrl+C to report the cancelled results. Press Ctrl+C again to exit immediately without waiting. + +Pass the `--detach` flag to keep the checks running in the cloud instead — Ctrl+C then exits the CLI immediately without cancelling. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/cli/checkly-trigger.mdx b/cli/checkly-trigger.mdx index 9de0ac17..0611cbd4 100644 --- a/cli/checkly-trigger.mdx +++ b/cli/checkly-trigger.mdx @@ -21,7 +21,7 @@ npx checkly trigger [options] | Option | Required | Description | |--------|----------|-------------| | `--config, -c` | - | The Checkly CLI configuration file. If not passed, uses the `checkly.config.ts\|js` file in the current directory. | -| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C; skips the cancellation prompt. | +| `--detach, -d` | - | Keep checks running in the cloud when you stop the CLI with Ctrl+C, instead of cancelling the run. | | `--env, -e` | - | Env vars to be passed to the check run. Default: empty. Multiple values can be passed. | | `--env-file` | - | dotenv file path to be passed. For example `--env-file="./.env"` | | `--fail-on-no-matching` | - | Exit with a failing status code when there are no matching tests. | @@ -53,7 +53,7 @@ npx checkly trigger -c="./checkly.staging.config.ts" -Skip the cancellation prompt. By default, pressing Ctrl+C during a recorded run opens a prompt to cancel the test session. With `--detach`, the CLI exits immediately instead, and the checks keep running in the cloud. +By default, pressing Ctrl+C during a recorded run cancels the test session. With `--detach`, Ctrl+C exits the CLI immediately instead, leaving the checks running in the cloud. **Usage:** @@ -392,9 +392,11 @@ npx checkly trigger --tags staging --record --test-session-name "Pre-prod valida Available in CLI v8.0.0+. -`checkly trigger` records a test session by default, so pressing Ctrl+C opens a prompt to cancel it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. +`checkly trigger` records a test session by default, so pressing Ctrl+C cancels it. Cancellation applies only to Playwright Check Suite runs inside the session; other check types finish normally. Runs started with `--no-record` cannot be cancelled. -Pass the `--detach` flag to skip the prompt — Ctrl+C then exits the CLI immediately and the checks keep running in the cloud. +The CLI keeps running after the first Ctrl+C to report the cancelled results. Press Ctrl+C again to exit immediately without waiting. + +Pass the `--detach` flag to keep the checks running in the cloud instead — Ctrl+C then exits the CLI immediately without cancelling. See [Cancellation](/concepts/cancellation) for the full flow. diff --git a/concepts/cancellation.mdx b/concepts/cancellation.mdx index f1b0f904..a6f46759 100644 --- a/concepts/cancellation.mdx +++ b/concepts/cancellation.mdx @@ -48,7 +48,7 @@ curl -X POST https://api.checklyhq.com/v1/test-sessions/a1b2c3d4-e5f6-7890-abcd- CLI cancellation is available in CLI v8.0.0+. -Press Ctrl+C during a recorded test session run — `checkly test`, `checkly trigger`, and `checkly pw-test` all record by default — to open a cancellation prompt. +Press Ctrl+C during a recorded test session run — `checkly test`, `checkly trigger`, and `checkly pw-test` all record by default — to cancel the session. The CLI keeps running to report the cancelled results; press Ctrl+C again to exit immediately. See the [CLI reference](/cli/overview) for command-specific behavior. From 5f2839ac463bb6fc97b8a5428ec7236a5788a82a Mon Sep 17 00:00:00 2001 From: miliberlin Date: Fri, 22 May 2026 14:41:04 +0200 Subject: [PATCH 13/13] feat: reset openai spec --- api-reference/openapi.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/api-reference/openapi.json b/api-reference/openapi.json index 5e34eb3f..c8afa511 100644 --- a/api-reference/openapi.json +++ b/api-reference/openapi.json @@ -6,7 +6,7 @@ keep it secure! Authentication to the API is performed using the Bearer auth method in the Authorization header and using the account ID. For example, set **Authorization** header while using cURL: `curl -H \"Authorization: Bearer [apiKey]\" \"X-Checkly-Account: [accountId]\"` -"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"TriggerTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","minLength":1,"description":"A short description for the testing environment."},"repoUrl":{"type":"string","nullable":true},"commitId":{"type":"string","nullable":true},"commitOwner":{"type":"string","nullable":true},"commitMessage":{"type":"string","nullable":true},"branchName":{"type":"string","nullable":true}}},"TestSessionResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","format":"uuid"},"testSessionResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","nullable":true,"format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups associated with this result."},"resultType":{"type":"string","enum":["FINAL","ATTEMPT","PENDING"]},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"}},"required":["testSessionResultId","testSessionResultLink","checkType","errorGroupIds","status","hasErrors","hasFailures","isDegraded","aborted"]},"TriggerTestSessionRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the test session."},"runLocation":{"type":"string","minLength":1,"description":"A public region code or private location slug name."},"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."},"allowDeactivated":{"type":"boolean","default":false,"description":"Allow deactivated checks to match."}}},"environmentVariables":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionEnvironmentVariable"},"maxItems":50},"retryStrategy":{"anyOf":[{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["FIXED","LINEAR","EXPONENTIAL"]},"maxRetries":{"type":"number","minimum":1,"maximum":10,"default":2},"maxDurationSeconds":{"type":"number","minimum":0,"maximum":600,"default":600}},"required":["type"]},{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["SINGLE_RETRY"]}},"required":["type"]},{"nullable":true}]},"refreshCache":{"type":"boolean","default":false,"description":"Skip existing caches and install dependencies from scratch."},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"TestSessionEnvironmentVariable":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"nullable":true},"secret":{"type":"boolean","enum":[true]}},"required":["key","value","secret"]},{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"type":"string","nullable":true,"minLength":1},"secret":{"type":"boolean","enum":[false],"default":false}},"required":["key","value"]}]},"CheckSessionsV1CancelRequest":{"type":"object","properties":{"sequenceId":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."}},"additionalProperties":false},"TestSessionsV1CancelRequest":{"type":"object","properties":{"sequenceId":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."}},"additionalProperties":false},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AwaitTestSessionCompletionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","stoppedAt","timeElapsed"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"FindOneTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":null,"nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":null,"nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":null,"nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":null,"nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.773Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-20T15:50:40.868Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model247":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model248":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model249":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model248"}},"Model250":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model251":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model252":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model253":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model254":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model255":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model253"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model254"},"reminders":{"$ref":"#/components/schemas/Model255"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model249"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model250"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model251"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model252"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. +"}},"schemas":{"CheckSessionsV2TriggerResponse":{"type":"object","properties":{"sessions":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckSession"}}},"required":["sessions"]},"CheckSessionsV2CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource"]},"ApiError":{"type":"object","properties":{"statusCode":{"type":"number"},"error":{"type":"string"},"message":{"type":"string"}},"required":["statusCode","error","message"]},"CheckSessionsV2TriggerRequest":{"type":"object","properties":{"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string"}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."}},"description":"Optional filters selecting which checks to trigger."},"refreshCache":{"type":"boolean","default":false,"description":"Refresh the selected checks cache before triggering the sessions."}}},"TriggerTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"TestSessionMetadata":{"type":"object","properties":{"environment":{"type":"string","minLength":1,"description":"A short description for the testing environment."},"repoUrl":{"type":"string","nullable":true},"commitId":{"type":"string","nullable":true},"commitOwner":{"type":"string","nullable":true},"commitMessage":{"type":"string","nullable":true},"branchName":{"type":"string","nullable":true}}},"TestSessionResult":{"type":"object","properties":{"testSessionResultId":{"type":"string","format":"uuid"},"testSessionResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","nullable":true,"format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups associated with this result."},"resultType":{"type":"string","enum":["FINAL","ATTEMPT","PENDING"]},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"}},"required":["testSessionResultId","testSessionResultLink","checkType","errorGroupIds","status","hasErrors","hasFailures","isDegraded","aborted"]},"TriggerTestSessionRequest":{"type":"object","properties":{"name":{"type":"string","minLength":1,"description":"The name of the test session."},"runLocation":{"type":"string","minLength":1,"description":"A public region code or private location slug name."},"target":{"type":"object","properties":{"matchTags":{"type":"array","items":{"type":"array","items":{"type":"string","minLength":1}},"description":"Tags used to select checks to trigger. Each nested array is matched as one tag group."},"checkId":{"type":"array","items":{"type":"string","format":"uuid"},"description":"Check ID or list of check IDs to trigger."},"allowDeactivated":{"type":"boolean","default":false,"description":"Allow deactivated checks to match."}}},"environmentVariables":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionEnvironmentVariable"},"maxItems":50},"retryStrategy":{"anyOf":[{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["FIXED","LINEAR","EXPONENTIAL"]},"maxRetries":{"type":"number","minimum":1,"maximum":10,"default":2},"maxDurationSeconds":{"type":"number","minimum":0,"maximum":600,"default":600}},"required":["type"]},{"type":"object","properties":{"baseBackoffSeconds":{"type":"number","default":60},"sameRegion":{"type":"boolean","default":true},"onlyOn":{"type":"array","items":{"type":"string","enum":["NETWORK_ERROR"]}},"type":{"type":"string","enum":["SINGLE_RETRY"]}},"required":["type"]},{"nullable":true}]},"refreshCache":{"type":"boolean","default":false,"description":"Skip existing caches and install dependencies from scratch."},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"}},"required":["name","runLocation"]},"TestSessionEnvironmentVariable":{"anyOf":[{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"nullable":true},"secret":{"type":"boolean","enum":[true]}},"required":["key","value","secret"]},{"type":"object","properties":{"key":{"type":"string","minLength":1},"locked":{"type":"boolean","default":false},"value":{"type":"string","nullable":true,"minLength":1},"secret":{"type":"boolean","enum":[false],"default":false}},"required":["key","value"]}]},"CancelRequest":{"anyOf":[{"$ref":"#/components/schemas/CancelCheckSession"},{"$ref":"#/components/schemas/CancelTestSession"}]},"CancelCheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid","description":"The ID of the check session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["checkSessionId"],"additionalProperties":false},"SequenceIds":{"type":"array","items":{"type":"string","format":"uuid"},"minItems":1,"description":"Subset of sequence IDs to cancel. Omit to cancel all in-progress sequences."},"CancelTestSession":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid","description":"The ID of the test session to cancel."},"sequenceId":{"$ref":"#/components/schemas/SequenceIds"}},"required":["testSessionId"],"additionalProperties":false},"CheckSessionsV2CompletionResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["PASSED","FAILED","DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"CheckSessionsV2CheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","format":"uuid"},"checkResultLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"runLocation":{"type":"string"},"resultType":{"type":"string","nullable":true,"enum":["FINAL","ATTEMPT",null]},"hasErrors":{"type":"boolean"},"hasFailures":{"type":"boolean"},"isDegraded":{"type":"boolean"},"aborted":{"type":"boolean"},"isCancelled":{"type":"boolean"}},"required":["checkResultId","checkResultLink","checkId","checkType","name","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"AwaitTestSessionCompletionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":false,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","stoppedAt","timeElapsed"]},"AccountMembersList":{"type":"object","properties":{"members":{"type":"array","items":{"$ref":"#/components/schemas/AccountMembersListItems"}},"length":{"type":"integer","minimum":0,"description":"Number of items returned in this page. This is not the total matching count."},"nextId":{"type":"string","nullable":true,"description":"Opaque cursor for the next page. Null means there are no more results."}},"required":["members","length","nextId"]},"AccountMembersListItems":{"oneOf":[{"$ref":"#/components/schemas/AccountMember"},{"$ref":"#/components/schemas/AccountInvite"}],"discriminator":{"propertyName":"type","mapping":{"member":"#/components/schemas/AccountMember","invite":"#/components/schemas/AccountInvite"}}},"AccountMember":{"type":"object","properties":{"type":{"type":"string","enum":["member"]},"accountId":{"type":"string","format":"uuid"},"userId":{"type":"string","format":"uuid"},"name":{"type":"string","nullable":true},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["ACTIVE"]},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"isSupportMembership":{"type":"boolean"},"ssoEnabled":{"type":"boolean"},"mfaEnabled":{"type":"boolean"}},"required":["type","accountId","userId","name","email","role","status","createdAt","updatedAt","isSupportMembership","ssoEnabled","mfaEnabled"]},"AccountInvite":{"type":"object","properties":{"type":{"type":"string","enum":["invite"]},"id":{"type":"string","format":"uuid"},"accountId":{"type":"string","format":"uuid"},"email":{"type":"string","format":"email"},"role":{"type":"string","enum":["ADMIN","READ_WRITE","READ_RUN","READ_ONLY"]},"status":{"type":"string","enum":["PENDING","EXPIRED"]},"inviterEmail":{"type":"string","format":"email"},"createdAt":{"type":"string","format":"date-time"},"updatedAt":{"type":"string","format":"date-time"},"expiresAt":{"type":"string","format":"date-time"}},"required":["type","id","accountId","email","role","status","inviterEmail","createdAt","updatedAt","expiresAt"]},"CheckSessionsV2FindOneResponse":{"type":"object","properties":{"checkSessionId":{"type":"string","format":"uuid"},"checkSessionLink":{"type":"string","format":"uri"},"checkId":{"type":"string","format":"uuid"},"checkType":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"name":{"type":"string"},"status":{"type":"string","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"runLocations":{"type":"array","items":{"type":"string"}},"runSource":{"type":"string","nullable":true,"enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API",null]},"results":{"type":"array","items":{"$ref":"#/components/schemas/CheckSessionsV2CheckResult"}}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations","runSource","results"]},"FindOneTestSessionResponse":{"type":"object","properties":{"testSessionId":{"type":"string","format":"uuid"},"testSessionLink":{"type":"string","format":"uri"},"name":{"type":"string"},"status":{"type":"string","enum":["RUNNING","FAILED","PASSED","CANCELLED"]},"errorGroupIds":{"type":"array","items":{"type":"string","format":"uuid"},"description":"IDs of the test-session error groups observed in this test session."},"startedAt":{"type":"string","nullable":false,"format":"date-time"},"stoppedAt":{"type":"string","nullable":true,"format":"date-time"},"timeElapsed":{"type":"number"},"metadata":{"$ref":"#/components/schemas/TestSessionMetadata"},"results":{"type":"array","items":{"$ref":"#/components/schemas/TestSessionResult"}}},"required":["testSessionId","testSessionLink","name","status","errorGroupIds","startedAt","timeElapsed"]},"RetryStrategyType":{"type":"string","description":"Determines which type of retry strategy to use.","enum":["FIXED","LINEAR","EXPONENTIAL","SINGLE_RETRY"]},"RetryOnlyOnValue":{"type":"string","description":"The HTTP request could not be completed due to a network error: no response status code was received","enum":["NETWORK_ERROR"]},"RetryOnlyOn":{"type":"array","x-constraint":{"length":1,"unique":true,"single":true},"items":{"$ref":"#/components/schemas/RetryOnlyOnValue"}},"RetryStrategy":{"type":"object","description":"The strategy to determine how failed checks are retried.","nullable":true,"properties":{"type":{"$ref":"#/components/schemas/RetryStrategyType"},"baseBackoffSeconds":{"type":"number","description":"The number of seconds to wait before the first retry attempt.","default":60},"sameRegion":{"type":"boolean","description":"Whether retries should be run in the same region as the initial check run.","default":true},"maxRetries":{"type":"number","description":"The maximum number of attempts to retry the check. Not supported for SINGLE_RETRY","minimum":1,"maximum":10},"maxDurationSeconds":{"type":"number","description":"The total amount of time to continue retrying the check. Not supported for SINGLE_RETRY","minimum":0,"maximum":600},"onlyOn":{"$ref":"#/components/schemas/RetryOnlyOn"}},"required":["type"]},"FallbackRetryStrategy":{"type":"string","enum":["FALLBACK"]},"tier":{"type":"string","description":"The add-on tier.","example":"starter","enum":["hobby","starter","team"]},"AddonTier":{"type":"object","properties":{"tier":{"$ref":"#/components/schemas/tier"},"tierDisplayName":{"type":"string","description":"The human-readable display name of the add-on tier.","example":"Communicate Starter"}}},"addons":{"type":"object","description":"The add-ons available to the account.","properties":{"communicate":{"$ref":"#/components/schemas/AddonTier"},"resolve":{"$ref":"#/components/schemas/AddonTier"}}},"settings":{"type":"object","description":"The settings of the account."},"alertSettings":{"type":"object","description":"The alert settings of the account."},"Account":{"type":"object","properties":{"id":{"type":"string","description":"Checkly account ID.","example":"d43967ee-81db-4e0b-a18c-06be5c995288","x-format":{"guid":true}},"name":{"type":"string","description":"The name of the account.","example":"Checkly"},"runtimeId":{"type":"string","description":"The account default runtime ID.","example":"2022.10"},"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"settings":{"$ref":"#/components/schemas/settings"},"alertSettings":{"$ref":"#/components/schemas/alertSettings"}},"required":["id"]},"AccountList":{"type":"array","items":{"$ref":"#/components/schemas/Account"}},"error":{"type":"string","enum":["Unauthorized"]},"attributes":{"type":"object"},"UnauthorizedError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[401]},"error":{"$ref":"#/components/schemas/error"},"message":{"type":"string","example":"Bad Token"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model1":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model1"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model2":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model2"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model3":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model3"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"Location":{"type":"object","properties":{"id":{"type":"string","description":"Location identifier (e.g. us-east-1)."},"name":{"type":"string","description":"Human-readable location name (e.g. N. Virginia)."},"available":{"type":"boolean","description":"Whether this location is available on the current plan."}},"required":["id","name","available"]},"all":{"type":"array","description":"All Checkly locations with availability for this account.","items":{"$ref":"#/components/schemas/Location"}},"Locations":{"type":"object","description":"Check run locations and limits for this account.","properties":{"all":{"$ref":"#/components/schemas/all"},"maxPerCheck":{"type":"integer","description":"Maximum locations selectable per check. Absent when unlimited.","minimum":1}},"required":["all"]},"type":{"type":"string","description":"Whether this entitlement is a boolean feature flag or a metered resource with a quantity limit.","enum":["flag","metered"]},"Model4":{"type":"string","description":"The minimum addon tier required (e.g. starter, team).","enum":["hobby","starter","team"]},"RequiredAddon":{"type":"object","description":"The addon and tier required to unlock this entitlement. Only present for disabled entitlements.","properties":{"name":{"type":"string","description":"The addon name."},"displayName":{"type":"string","description":"Human-readable addon name."},"tier":{"$ref":"#/components/schemas/Model4"},"tierDisplayName":{"type":"string","description":"Human-readable addon tier name."}},"required":["name","displayName","tier","tierDisplayName"]},"Entitlement":{"type":"object","properties":{"key":{"type":"string","description":"Unique entitlement identifier."},"name":{"type":"string","description":"Human-friendly display name."},"description":{"type":"string","description":"Short description of what this entitlement controls."},"type":{"$ref":"#/components/schemas/type"},"enabled":{"type":"boolean","description":"Whether this entitlement is available on the current plan."},"quantity":{"type":"integer","description":"Maximum allowed quantity. Only present for metered entitlements.","minimum":0},"requiredPlan":{"type":"string","description":"The minimum plan required to unlock this entitlement. Only present for disabled entitlements."},"requiredPlanDisplayName":{"type":"string","description":"Human-readable name of the required plan."},"requiredAddon":{"$ref":"#/components/schemas/RequiredAddon"}},"required":["key","name","description","type","enabled"]},"entitlements":{"type":"array","description":"List of entitled features for this account.","items":{"$ref":"#/components/schemas/Entitlement"}},"Entitlements":{"type":"object","properties":{"plan":{"type":"string","description":"The account plan type.","example":"team"},"planDisplayName":{"type":"string","description":"The human-readable display name of the account plan.","example":"Team"},"addons":{"$ref":"#/components/schemas/addons"},"locations":{"$ref":"#/components/schemas/Locations"},"entitlements":{"$ref":"#/components/schemas/entitlements"}},"required":["plan","locations","entitlements"]},"Model5":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelConfig":{"type":"object","description":"The configuration details for this alert channel. These can be very different based on the type of the channel."},"AlertChanelSubscription":{"type":"object","properties":{"id":{"type":"number","example":1},"checkId":{"type":"string","example":"47ccf418-6224-429c-a096-637364249882","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"AlertChanelSubscriptionList":{"type":"array","description":"All checks subscribed to this channel.","example":[],"items":{"$ref":"#/components/schemas/AlertChanelSubscription"}},"AlertChannel":{"type":"object","properties":{"id":{"type":"number","example":1,"x-constraint":{"sign":"positive"}},"type":{"$ref":"#/components/schemas/Model5"},"config":{"$ref":"#/components/schemas/AlertChannelConfig"},"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["id","type","config"]},"AlertChannelList":{"type":"array","items":{"$ref":"#/components/schemas/AlertChannel"}},"Model6":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/Model6"},"config":{"$ref":"#/components/schemas/AlertChannelCreateConfig"},"sendRecovery":{"type":"boolean"},"sendFailure":{"type":"boolean"},"sendDegraded":{"type":"boolean"},"sslExpiry":{"type":"boolean","description":"Determines if an alert should be sent for expiring SSL certificates.","default":false},"sslExpiryThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates.","default":30,"minimum":1,"maximum":30},"autoSubscribe":{"type":"boolean","description":"Automatically subscribe newly created checks to this alert channel.","default":false}},"required":["type","config"]},"Model7":{"type":"string","enum":["Payment Required"]},"PaymentRequiredError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[402]},"error":{"$ref":"#/components/schemas/Model7"},"message":{"type":"string","example":"Payment Required"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"AlertChannelSubscriptionCreate":{"type":"object","properties":{"checkId":{"type":"string","description":"You can either pass a checkId or a groupId, but not both.","example":"0bbfc00c-44df-46a7-a4d9-ba38deca8bfd","nullable":true,"x-format":{"guid":true}},"groupId":{"type":"number","description":"You can either pass a checkId or a groupId, but not both.","example":null,"nullable":true,"x-constraint":{"sign":"positive"}},"activated":{"type":"boolean"}},"required":["activated"]},"Model8":{"type":"string","description":"The type of alert channel (SMS, Slack, Webhook, etc).","enum":["EMAIL","SLACK","SLACK_APP","WEBHOOK","SMS","PAGERDUTY","OPSGENIE","CALL"]},"status":{"type":"string","description":"The status of the alert.","enum":["IN_PROGRESS","SUCCESS","FAILURE","RATE_LIMITED"]},"alertConfig":{"type":"object","description":"The configuration which was used to send the alert."},"checkType":{"type":"string","description":"The type of the check.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"AlertNotification":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert notification."},"type":{"$ref":"#/components/schemas/Model8"},"status":{"$ref":"#/components/schemas/status"},"alertConfig":{"$ref":"#/components/schemas/alertConfig"},"notificationResult":{"type":"string","description":"The result of sending the alert notification.For example, this could be the response body of the Webhook.","nullable":true},"timestamp":{"type":"string","format":"date-time","description":"The time that the alert was sent.","nullable":true},"checkType":{"$ref":"#/components/schemas/checkType"},"checkId":{"type":"string","description":"The ID of the check."},"checkAlertId":{"type":"string","description":"The ID of the check alert."},"alertChannelId":{"type":"number","description":"The ID of the alert channel which this alert was sent to."},"checkResultId":{"type":"string","description":"The ID of the corresponding check result."}}},"AlertNotificationList":{"type":"array","items":{"$ref":"#/components/schemas/AlertNotification"}},"Model9":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"tags":{"type":"array","items":{"type":"string"}},"series":{"type":"array","items":{"type":"string"}},"pagination":{"type":"object","properties":{"page":{"type":"number"},"limit":{"type":"number"}}},"unit":{"type":"string","enum":["milliseconds","score","count","percentage"]},"aggregation":{"type":"string","enum":["avg","max","median","min","p50","p90","p95","p99","stddev","sum"]},"responseTime":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"availability":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"retries":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"responseTime_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"wait_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"dns_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"tcp_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"firstByte_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"download_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"metadata":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"wait":{"$ref":"#/components/schemas/wait"},"dns":{"$ref":"#/components/schemas/dns"},"tcp":{"$ref":"#/components/schemas/tcp"},"firstByte":{"$ref":"#/components/schemas/firstByte"},"download":{"$ref":"#/components/schemas/download"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"wait_avg":{"$ref":"#/components/schemas/wait_avg"},"wait_max":{"$ref":"#/components/schemas/wait_max"},"wait_median":{"$ref":"#/components/schemas/wait_median"},"wait_min":{"$ref":"#/components/schemas/wait_min"},"wait_p50":{"$ref":"#/components/schemas/wait_p50"},"wait_p90":{"$ref":"#/components/schemas/wait_p90"},"wait_p95":{"$ref":"#/components/schemas/wait_p95"},"wait_p99":{"$ref":"#/components/schemas/wait_p99"},"wait_stddev":{"$ref":"#/components/schemas/wait_stddev"},"wait_sum":{"$ref":"#/components/schemas/wait_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"tcp_avg":{"$ref":"#/components/schemas/tcp_avg"},"tcp_max":{"$ref":"#/components/schemas/tcp_max"},"tcp_median":{"$ref":"#/components/schemas/tcp_median"},"tcp_min":{"$ref":"#/components/schemas/tcp_min"},"tcp_p50":{"$ref":"#/components/schemas/tcp_p50"},"tcp_p90":{"$ref":"#/components/schemas/tcp_p90"},"tcp_p95":{"$ref":"#/components/schemas/tcp_p95"},"tcp_p99":{"$ref":"#/components/schemas/tcp_p99"},"tcp_stddev":{"$ref":"#/components/schemas/tcp_stddev"},"tcp_sum":{"$ref":"#/components/schemas/tcp_sum"},"firstByte_avg":{"$ref":"#/components/schemas/firstByte_avg"},"firstByte_max":{"$ref":"#/components/schemas/firstByte_max"},"firstByte_median":{"$ref":"#/components/schemas/firstByte_median"},"firstByte_min":{"$ref":"#/components/schemas/firstByte_min"},"firstByte_p50":{"$ref":"#/components/schemas/firstByte_p50"},"firstByte_p90":{"$ref":"#/components/schemas/firstByte_p90"},"firstByte_p95":{"$ref":"#/components/schemas/firstByte_p95"},"firstByte_p99":{"$ref":"#/components/schemas/firstByte_p99"},"firstByte_stddev":{"$ref":"#/components/schemas/firstByte_stddev"},"firstByte_sum":{"$ref":"#/components/schemas/firstByte_sum"},"download_avg":{"$ref":"#/components/schemas/download_avg"},"download_max":{"$ref":"#/components/schemas/download_max"},"download_median":{"$ref":"#/components/schemas/download_median"},"download_min":{"$ref":"#/components/schemas/download_min"},"download_p50":{"$ref":"#/components/schemas/download_p50"},"download_p90":{"$ref":"#/components/schemas/download_p90"},"download_p95":{"$ref":"#/components/schemas/download_p95"},"download_p99":{"$ref":"#/components/schemas/download_p99"},"download_stddev":{"$ref":"#/components/schemas/download_stddev"},"download_sum":{"$ref":"#/components/schemas/download_sum"}}},"Model10":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model9"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"Model11":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"TTFB":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TTFB_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"FCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"LCP_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"CLS_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"TBT_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"consoleErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"networkErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"userScriptErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"documentErrors_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model12":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"TTFB":{"$ref":"#/components/schemas/TTFB"},"FCP":{"$ref":"#/components/schemas/FCP"},"LCP":{"$ref":"#/components/schemas/LCP"},"CLS":{"$ref":"#/components/schemas/CLS"},"TBT":{"$ref":"#/components/schemas/TBT"},"consoleErrors":{"$ref":"#/components/schemas/consoleErrors"},"networkErrors":{"$ref":"#/components/schemas/networkErrors"},"userScriptErrors":{"$ref":"#/components/schemas/userScriptErrors"},"documentErrors":{"$ref":"#/components/schemas/documentErrors"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"},"TTFB_avg":{"$ref":"#/components/schemas/TTFB_avg"},"TTFB_max":{"$ref":"#/components/schemas/TTFB_max"},"TTFB_median":{"$ref":"#/components/schemas/TTFB_median"},"TTFB_min":{"$ref":"#/components/schemas/TTFB_min"},"TTFB_p50":{"$ref":"#/components/schemas/TTFB_p50"},"TTFB_p90":{"$ref":"#/components/schemas/TTFB_p90"},"TTFB_p95":{"$ref":"#/components/schemas/TTFB_p95"},"TTFB_p99":{"$ref":"#/components/schemas/TTFB_p99"},"TTFB_stddev":{"$ref":"#/components/schemas/TTFB_stddev"},"TTFB_sum":{"$ref":"#/components/schemas/TTFB_sum"},"FCP_avg":{"$ref":"#/components/schemas/FCP_avg"},"FCP_max":{"$ref":"#/components/schemas/FCP_max"},"FCP_median":{"$ref":"#/components/schemas/FCP_median"},"FCP_min":{"$ref":"#/components/schemas/FCP_min"},"FCP_p50":{"$ref":"#/components/schemas/FCP_p50"},"FCP_p90":{"$ref":"#/components/schemas/FCP_p90"},"FCP_p95":{"$ref":"#/components/schemas/FCP_p95"},"FCP_p99":{"$ref":"#/components/schemas/FCP_p99"},"FCP_stddev":{"$ref":"#/components/schemas/FCP_stddev"},"FCP_sum":{"$ref":"#/components/schemas/FCP_sum"},"LCP_avg":{"$ref":"#/components/schemas/LCP_avg"},"LCP_max":{"$ref":"#/components/schemas/LCP_max"},"LCP_median":{"$ref":"#/components/schemas/LCP_median"},"LCP_min":{"$ref":"#/components/schemas/LCP_min"},"LCP_p50":{"$ref":"#/components/schemas/LCP_p50"},"LCP_p90":{"$ref":"#/components/schemas/LCP_p90"},"LCP_p95":{"$ref":"#/components/schemas/LCP_p95"},"LCP_p99":{"$ref":"#/components/schemas/LCP_p99"},"LCP_stddev":{"$ref":"#/components/schemas/LCP_stddev"},"LCP_sum":{"$ref":"#/components/schemas/LCP_sum"},"CLS_avg":{"$ref":"#/components/schemas/CLS_avg"},"CLS_max":{"$ref":"#/components/schemas/CLS_max"},"CLS_median":{"$ref":"#/components/schemas/CLS_median"},"CLS_min":{"$ref":"#/components/schemas/CLS_min"},"CLS_p50":{"$ref":"#/components/schemas/CLS_p50"},"CLS_p90":{"$ref":"#/components/schemas/CLS_p90"},"CLS_p95":{"$ref":"#/components/schemas/CLS_p95"},"CLS_p99":{"$ref":"#/components/schemas/CLS_p99"},"CLS_stddev":{"$ref":"#/components/schemas/CLS_stddev"},"CLS_sum":{"$ref":"#/components/schemas/CLS_sum"},"TBT_avg":{"$ref":"#/components/schemas/TBT_avg"},"TBT_max":{"$ref":"#/components/schemas/TBT_max"},"TBT_median":{"$ref":"#/components/schemas/TBT_median"},"TBT_min":{"$ref":"#/components/schemas/TBT_min"},"TBT_p50":{"$ref":"#/components/schemas/TBT_p50"},"TBT_p90":{"$ref":"#/components/schemas/TBT_p90"},"TBT_p95":{"$ref":"#/components/schemas/TBT_p95"},"TBT_p99":{"$ref":"#/components/schemas/TBT_p99"},"TBT_stddev":{"$ref":"#/components/schemas/TBT_stddev"},"TBT_sum":{"$ref":"#/components/schemas/TBT_sum"},"consoleErrors_avg":{"$ref":"#/components/schemas/consoleErrors_avg"},"consoleErrors_max":{"$ref":"#/components/schemas/consoleErrors_max"},"consoleErrors_median":{"$ref":"#/components/schemas/consoleErrors_median"},"consoleErrors_min":{"$ref":"#/components/schemas/consoleErrors_min"},"consoleErrors_p50":{"$ref":"#/components/schemas/consoleErrors_p50"},"consoleErrors_p90":{"$ref":"#/components/schemas/consoleErrors_p90"},"consoleErrors_p95":{"$ref":"#/components/schemas/consoleErrors_p95"},"consoleErrors_p99":{"$ref":"#/components/schemas/consoleErrors_p99"},"consoleErrors_stddev":{"$ref":"#/components/schemas/consoleErrors_stddev"},"consoleErrors_sum":{"$ref":"#/components/schemas/consoleErrors_sum"},"networkErrors_avg":{"$ref":"#/components/schemas/networkErrors_avg"},"networkErrors_max":{"$ref":"#/components/schemas/networkErrors_max"},"networkErrors_median":{"$ref":"#/components/schemas/networkErrors_median"},"networkErrors_min":{"$ref":"#/components/schemas/networkErrors_min"},"networkErrors_p50":{"$ref":"#/components/schemas/networkErrors_p50"},"networkErrors_p90":{"$ref":"#/components/schemas/networkErrors_p90"},"networkErrors_p95":{"$ref":"#/components/schemas/networkErrors_p95"},"networkErrors_p99":{"$ref":"#/components/schemas/networkErrors_p99"},"networkErrors_stddev":{"$ref":"#/components/schemas/networkErrors_stddev"},"networkErrors_sum":{"$ref":"#/components/schemas/networkErrors_sum"},"userScriptErrors_avg":{"$ref":"#/components/schemas/userScriptErrors_avg"},"userScriptErrors_max":{"$ref":"#/components/schemas/userScriptErrors_max"},"userScriptErrors_median":{"$ref":"#/components/schemas/userScriptErrors_median"},"userScriptErrors_min":{"$ref":"#/components/schemas/userScriptErrors_min"},"userScriptErrors_p50":{"$ref":"#/components/schemas/userScriptErrors_p50"},"userScriptErrors_p90":{"$ref":"#/components/schemas/userScriptErrors_p90"},"userScriptErrors_p95":{"$ref":"#/components/schemas/userScriptErrors_p95"},"userScriptErrors_p99":{"$ref":"#/components/schemas/userScriptErrors_p99"},"userScriptErrors_stddev":{"$ref":"#/components/schemas/userScriptErrors_stddev"},"userScriptErrors_sum":{"$ref":"#/components/schemas/userScriptErrors_sum"},"documentErrors_avg":{"$ref":"#/components/schemas/documentErrors_avg"},"documentErrors_max":{"$ref":"#/components/schemas/documentErrors_max"},"documentErrors_median":{"$ref":"#/components/schemas/documentErrors_median"},"documentErrors_min":{"$ref":"#/components/schemas/documentErrors_min"},"documentErrors_p50":{"$ref":"#/components/schemas/documentErrors_p50"},"documentErrors_p90":{"$ref":"#/components/schemas/documentErrors_p90"},"documentErrors_p95":{"$ref":"#/components/schemas/documentErrors_p95"},"documentErrors_p99":{"$ref":"#/components/schemas/documentErrors_p99"},"documentErrors_stddev":{"$ref":"#/components/schemas/documentErrors_stddev"},"documentErrors_sum":{"$ref":"#/components/schemas/documentErrors_sum"}}},"Model13":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model11"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model12"}}},"checkIds":{"type":"array","description":"Array of check IDs to fetch analytics for.","minItems":1,"maxItems":100,"items":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}}},"Model14":{"type":"object","properties":{"checkIds":{"$ref":"#/components/schemas/checkIds"}},"required":["checkIds"]},"Model15":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":{"version":"uuidv4"}}},"checkType":{"$ref":"#/components/schemas/Model15"},"availability":{"type":"number","nullable":true},"responseTime_avg":{"type":"number","nullable":true},"responseTime_p50":{"type":"number","nullable":true},"responseTime_p95":{"type":"number","nullable":true},"responseTime_p99":{"type":"number","nullable":true},"latency_avg":{"type":"number","nullable":true},"latency_p50":{"type":"number","nullable":true},"latency_p95":{"type":"number","nullable":true},"latency_p99":{"type":"number","nullable":true},"packetLoss_avg":{"type":"number","nullable":true},"packetLoss_p95":{"type":"number","nullable":true},"packetLoss_p99":{"type":"number","nullable":true}},"required":["checkId","checkType"]},"Model17":{"type":"array","items":{"$ref":"#/components/schemas/Model16"}},"Model18":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"total":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"total_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model19":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"}}},"Model20":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model18"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model19"}}},"Model21":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model23":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model21"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model22"}}},"Model24":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"string":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model25":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model24"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"type":"object","properties":{"string":{"$ref":"#/components/schemas/string"}}}}},"Model26":{"type":"array","items":{"type":"string"}},"Model27":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model29":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model27"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model28"}}},"Model30":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model31":{"type":"object","properties":{"responseTime":{"$ref":"#/components/schemas/responseTime"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"responseTime_avg":{"$ref":"#/components/schemas/responseTime_avg"},"responseTime_max":{"$ref":"#/components/schemas/responseTime_max"},"responseTime_median":{"$ref":"#/components/schemas/responseTime_median"},"responseTime_min":{"$ref":"#/components/schemas/responseTime_min"},"responseTime_p50":{"$ref":"#/components/schemas/responseTime_p50"},"responseTime_p90":{"$ref":"#/components/schemas/responseTime_p90"},"responseTime_p95":{"$ref":"#/components/schemas/responseTime_p95"},"responseTime_p99":{"$ref":"#/components/schemas/responseTime_p99"},"responseTime_stddev":{"$ref":"#/components/schemas/responseTime_stddev"},"responseTime_sum":{"$ref":"#/components/schemas/responseTime_sum"}}},"Model32":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model30"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model31"}}},"Model33":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"connection":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"connection_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_avg":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_max":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_median":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_min":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p50":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p90":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p95":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_p99":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_stddev":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"data_sum":{"type":"object","properties":{"unit":{"$ref":"#/components/schemas/unit"},"label":{"type":"string"},"aggregation":{"$ref":"#/components/schemas/aggregation"}}},"Model34":{"type":"object","properties":{"total":{"$ref":"#/components/schemas/total"},"dns":{"$ref":"#/components/schemas/dns"},"connection":{"$ref":"#/components/schemas/connection"},"data":{"$ref":"#/components/schemas/data"},"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"},"total_avg":{"$ref":"#/components/schemas/total_avg"},"total_max":{"$ref":"#/components/schemas/total_max"},"total_median":{"$ref":"#/components/schemas/total_median"},"total_min":{"$ref":"#/components/schemas/total_min"},"total_p50":{"$ref":"#/components/schemas/total_p50"},"total_p90":{"$ref":"#/components/schemas/total_p90"},"total_p95":{"$ref":"#/components/schemas/total_p95"},"total_p99":{"$ref":"#/components/schemas/total_p99"},"total_stddev":{"$ref":"#/components/schemas/total_stddev"},"total_sum":{"$ref":"#/components/schemas/total_sum"},"dns_avg":{"$ref":"#/components/schemas/dns_avg"},"dns_max":{"$ref":"#/components/schemas/dns_max"},"dns_median":{"$ref":"#/components/schemas/dns_median"},"dns_min":{"$ref":"#/components/schemas/dns_min"},"dns_p50":{"$ref":"#/components/schemas/dns_p50"},"dns_p90":{"$ref":"#/components/schemas/dns_p90"},"dns_p95":{"$ref":"#/components/schemas/dns_p95"},"dns_p99":{"$ref":"#/components/schemas/dns_p99"},"dns_stddev":{"$ref":"#/components/schemas/dns_stddev"},"dns_sum":{"$ref":"#/components/schemas/dns_sum"},"connection_avg":{"$ref":"#/components/schemas/connection_avg"},"connection_max":{"$ref":"#/components/schemas/connection_max"},"connection_median":{"$ref":"#/components/schemas/connection_median"},"connection_min":{"$ref":"#/components/schemas/connection_min"},"connection_p50":{"$ref":"#/components/schemas/connection_p50"},"connection_p90":{"$ref":"#/components/schemas/connection_p90"},"connection_p95":{"$ref":"#/components/schemas/connection_p95"},"connection_p99":{"$ref":"#/components/schemas/connection_p99"},"connection_stddev":{"$ref":"#/components/schemas/connection_stddev"},"connection_sum":{"$ref":"#/components/schemas/connection_sum"},"data_avg":{"$ref":"#/components/schemas/data_avg"},"data_max":{"$ref":"#/components/schemas/data_max"},"data_median":{"$ref":"#/components/schemas/data_median"},"data_min":{"$ref":"#/components/schemas/data_min"},"data_p50":{"$ref":"#/components/schemas/data_p50"},"data_p90":{"$ref":"#/components/schemas/data_p90"},"data_p95":{"$ref":"#/components/schemas/data_p95"},"data_p99":{"$ref":"#/components/schemas/data_p99"},"data_stddev":{"$ref":"#/components/schemas/data_stddev"},"data_sum":{"$ref":"#/components/schemas/data_sum"}}},"Model35":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model33"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/Model34"}}},"Model36":{"type":"string","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model37":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model36"},"activated":{"type":"boolean"},"muted":{"type":"boolean"},"frequency":{"type":"number"},"from":{"type":"string","format":"date"},"to":{"type":"string","format":"date"},"tags":{"$ref":"#/components/schemas/tags"},"series":{"$ref":"#/components/schemas/series"},"pagination":{"$ref":"#/components/schemas/pagination"},"metadata":{"$ref":"#/components/schemas/metadata"}}},"alertType":{"type":"string","description":"The type of alert.","example":"ALERT_FAILURE","enum":["NO_ALERT","ALERT_FAILURE","ALERT_FAILURE_REMAIN","ALERT_FAILURE_DEGRADED","ALERT_RECOVERY","ALERT_DEGRADED","ALERT_DEGRADED_REMAIN","ALERT_DEGRADED_FAILURE","ALERT_DEGRADED_RECOVERY","ALERT_SSL"]},"Model38":{"type":"string","description":"The type of the check.","example":"API","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"CheckAlert":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this alert.","example":"1"},"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this alert belongs to.","example":"db147a95-6ed6-44c9-a584-c5dca2db3aaa"},"alertType":{"$ref":"#/components/schemas/alertType"},"checkType":{"$ref":"#/components/schemas/Model38"},"runLocation":{"type":"string","description":"What data center location this check alert was triggered from.","example":"us-east-1"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this.","example":10},"error":{"type":"string","description":"Any specific error messages that were part of the failing check triggering the alert.","example":"OK","nullable":true},"statusCode":{"type":"string","description":"The status code of the response. Only applies to API checks.","example":"200","nullable":true},"created_at":{"type":"string","format":"date","description":"The date and time this check alert was created."},"startedAt":{"type":"string","format":"date","description":"The date and time this check alert was started."}},"required":["name"]},"CheckAlertList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlert"}},"CheckGroupTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"Model39":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckGroupLocationList":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model39"}},"KeyValue":{"type":"object","properties":{"key":{"type":"string"},"value":{"type":"string","default":""},"locked":{"type":"boolean","default":false}},"required":["key","value"]},"HeaderList":{"type":"array","example":[{"key":"Cache-Control","value":"no-store"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"QueryParameterList":{"type":"array","example":[{"key":"Page","value":"1"}],"items":{"$ref":"#/components/schemas/KeyValue"}},"AssertionSource":{"type":"string","enum":["STATUS_CODE","JSON_BODY","HEADERS","TEXT_BODY","RESPONSE_TIME"]},"AssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Assertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/AssertionSource"},"comparison":{"$ref":"#/components/schemas/AssertionComparison"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"AssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/Assertion"}},"BasicAuth":{"type":"object","nullable":true,"properties":{"username":{"type":"string","example":"admin","default":""},"password":{"type":"string","example":"abc12345","default":""}},"required":["username","password"]},"CheckGroupAPICheckDefaults":{"type":"object","properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"EnvironmentVariableGet":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"EnvironmentVariableList":{"type":"array","nullable":true,"items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"escalationType":{"type":"string","description":"Determines what type of escalation to use.","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"AlertSettingsReminders":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification.","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send.","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsSSLCertificates":{"type":"object","description":"[DEPRECATED] `sslCertificates` is deprecated and is not longer used. Please ignore it, will be removed in a future version.","properties":{"enabled":{"type":"boolean","description":"Determines if alert notifications should be send for expiring SSL certificates."},"alertThreshold":{"type":"integer","description":"At what moment in time to start alerting on SSL certificates."}}},"AlertSettingsRunBasedEscalation":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send.","enum":[1,2,3,4,5]}}},"AlertSettingsTimeBasedEscalation":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send.","enum":[5,10,15,30]}}},"parallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"CheckGroupAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model40":{"type":"object","description":"Alert channel subscription.","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"AlertChannelSubscriptionCreateList":{"type":"array","description":"List of alert channel subscriptions.","items":{"$ref":"#/components/schemas/Model40"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"privateLocations":{"type":"array","description":"An array of one or more private locations where to run the check.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroup":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not."},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers."},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/CheckGroupLocationList"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/EnvironmentVariableList"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead."},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","nullable":true},"alertSettings":{"$ref":"#/components/schemas/CheckGroupAlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreateList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"nullable":true},"runtimeId":{"$ref":"#/components/schemas/runtimeId"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false,"nullable":true}},"required":["name","activated","concurrency","apiCheckDefaults"]},"CheckGroupList":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroup"}},"Model41":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model42":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model41"}},"CheckGroupCreateAPICheckDefaults":{"type":"object","example":{"url":"https://api.example.com/v1","headers":[{"key":"Cache-Control","value":"no-store"}],"queryParameters":[{"key":"Page","value":"1"}],"assertions":[{"source":"STATUS_CODE","comparison":"NOT_EMPTY","target":"200"}],"basicAuth":{"username":"admin","password":"abc12345"}},"default":{},"properties":{"url":{"type":"string","description":"The base url for this group which you can reference with the {{GROUP_BASE_URL}} variable in all group checks.","example":"https://api.example.com/v1","default":"","nullable":true},"headers":{"$ref":"#/components/schemas/HeaderList"},"queryParameters":{"$ref":"#/components/schemas/QueryParameterList"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}}},"Model43":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"EnvironmentVariableUpdate":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string","description":"The value of the environment variable.","example":"bAxD7biGCZL6K60Q"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["value"]},"environmentVariables":{"type":"array","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariableUpdate"}},"AlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model44":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model45":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model42"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model43"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model44"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model45"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}},"required":["name"]},"CheckGroupCheck":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"Model46":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model46"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model47":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model48":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model47"}},"Model49":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model50":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model51":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"CheckGroupUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model48"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model49"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check group.","default":true},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model50"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model51"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":false},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]}}},"Model52":{"type":"array","items":{"$ref":"#/components/schemas/CheckGroupCheck"}},"assertions":{"type":"array","description":"List of API check assertions.","example":[{"source":"STATUS_CODE","target":200}],"nullable":true,"items":{"type":"string"}},"headers":{"type":"object"},"params":{"type":"object"},"request":{"type":"object","description":"The request for the API.","properties":{"method":{"type":"string","example":"GET"},"url":{"type":"string","example":"https://api.checklyhq.com"},"data":{"type":"string","example":""},"headers":{"$ref":"#/components/schemas/headers"},"params":{"$ref":"#/components/schemas/params"}}},"timings":{"type":"object"},"timingPhases":{"type":"object"},"response":{"type":"object","description":"The API response.","properties":{"status":{"type":"number","example":200},"statusText":{"type":"string","example":"OK"},"body":{"type":"string","example":" Checkly Public API "},"headers":{"$ref":"#/components/schemas/headers"},"timings":{"$ref":"#/components/schemas/timings"},"timingPhases":{"$ref":"#/components/schemas/timingPhases"}}},"jobLog":{"type":"object","description":"Check run log results.","nullable":true},"jobAssets":{"type":"array","description":"Assets generated from the check run.","example":null,"nullable":true,"items":{"type":"string"}},"CheckResultAPI":{"type":"object","description":"The response data for an API check.","nullable":true,"properties":{"assertions":{"$ref":"#/components/schemas/assertions"},"request":{"$ref":"#/components/schemas/request"},"response":{"$ref":"#/components/schemas/response"},"requestError":{"type":"string","description":"Describes if an error occurred on the request.","example":null,"nullable":true},"jobLog":{"$ref":"#/components/schemas/jobLog"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"pcapDataUrl":{"type":"string","description":"Packet capture data if available as redirect/download URL.","nullable":true}}},"traceSummary":{"type":"object","description":"The summary of errors in the check run."},"pages":{"type":"array","description":"List of pages used on the check run.","example":[{"url":"https://www.checklyhq.com/","webVitals":{"CLS":{"score":"GOOD","value":0.000146484375}}}],"items":{"type":"string"}},"playwrightTestVideos":{"type":"array","description":"List of Playwright Test videos.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot-1675691043856.webm"],"items":{"type":"string"}},"errors":{"type":"array","description":"List of errors on the check run.","example":[],"items":{"type":"string"}},"Model53":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"playwrightTestTraces":{"type":"array","description":"List of Playwright Test traces.","example":["https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/visit-page-and-take-screenshot.zip"],"items":{"type":"string"}},"CheckResultBrowser":{"type":"object","description":"The response data for a browser check.","example":null,"nullable":true,"properties":{"type":{"type":"string","description":"The type of framework the check is using.","example":"PLAYWRIGHT"},"traceSummary":{"$ref":"#/components/schemas/traceSummary"},"pages":{"$ref":"#/components/schemas/pages"},"playwrightTestVideos":{"$ref":"#/components/schemas/playwrightTestVideos"},"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model53"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"Model54":{"type":"array","description":"Check run log results.","example":{"time":1648573423995,"msg":"Starting job","level":"DEBUG"},"nullable":true,"items":{"type":"string"}},"MultiStepResultBrowser":{"type":"object","description":"The response data for a multi-step check.","example":null,"nullable":true,"properties":{"errors":{"$ref":"#/components/schemas/errors"},"endTime":{"type":"number","description":"End time of the check run.","example":1648573423995},"startTime":{"type":"number","description":"Start time of the check run.","example":1648573423994},"runtimeVersion":{"type":"string","description":"Active runtime version.","example":"2023.09"},"jobLog":{"$ref":"#/components/schemas/Model54"},"jobAssets":{"$ref":"#/components/schemas/jobAssets"},"playwrightTestTraces":{"$ref":"#/components/schemas/playwrightTestTraces"},"playwrightTestJsonReportFile":{"type":"string","description":"Playwright Test JSON report.","example":"https://api.checklyhq.com/v1/assets/checkRunData/eu-central-1/00000000-0000-0000-0000-0000000000/00000000-0000-0000-0000-0000000000/1675691025832/report.json"}}},"AgenticAssertion":{"type":"object","properties":{"condition":{"type":"string","description":"Human-readable condition the agent evaluated.","example":"The homepage returns an HTTP 200 status"},"passed":{"type":"boolean","description":"Whether the assertion passed.","example":true},"actual":{"type":"string","description":"What the agent actually observed.","example":"200"},"expected":{"type":"string","description":"What the assertion required.","example":"200"}}},"Model55":{"type":"array","description":"List of assertions the agent evaluated during the run.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticAssertion"}},"secrets":{"type":"array","description":"Environment variable names the suggestion would require.","example":["TEST_USER_EMAIL","TEST_USER_PASSWORD"],"items":{"type":"string"}},"category":{"type":"string","description":"Category of the suggestion.","example":"credentials","enum":["credentials","endpoint","configuration"]},"AgenticSuggestion":{"type":"object","properties":{"summary":{"type":"string","description":"Human-readable summary of the agent's suggestion.","example":"Monitor the checkout flow end-to-end"},"prompt":{"type":"string","description":"Prompt fragment the user can append to extend the check.","example":"Sign in and verify the checkout page loads"},"promptReplacement":{"type":"string","description":"Full replacement prompt the user can apply when the suggestion is a correction instead of an append-only fragment.","example":"Sign in with {{TEST_USER_EMAIL}} and verify the checkout page loads"},"secrets":{"$ref":"#/components/schemas/secrets"},"category":{"$ref":"#/components/schemas/category"}}},"suggestions":{"type":"array","description":"Suggestions the agent produced for extending the check.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticSuggestion"}},"Model56":{"type":"string","description":"Kind of step emitted by the agent.","example":"tool_call","enum":["tool_call","tool_result","message"]},"input":{"type":"object","description":"Input passed to the tool, when applicable."},"AgenticStep":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model56"},"name":{"type":"string","description":"Name of the tool invoked (for tool_call / tool_result steps).","example":"http_request"},"input":{"$ref":"#/components/schemas/input"},"output":{"type":"string","description":"Output text or message body."},"timestamp":{"type":"string","description":"ISO timestamp when the step was emitted.","example":"2026-04-06T14:15:22.000Z"},"sequenceNumber":{"type":"integer","description":"Monotonic sequence number within a run.","example":3}}},"steps":{"type":"array","description":"Sequence of tool calls and messages emitted by the agent.","nullable":true,"items":{"$ref":"#/components/schemas/AgenticStep"}},"Model57":{"type":"object"},"Model58":{"type":"array","description":"Errors recorded during the run, if any.","nullable":true,"items":{"$ref":"#/components/schemas/Model57"}},"artifactManifest":{"type":"object","description":"Map of artifact file paths to human-readable descriptions.","nullable":true},"CheckResultAgentic":{"type":"object","description":"The response data for an agentic check.","nullable":true,"properties":{"summary":{"type":"string","description":"Human-readable recap of the agent run written by the agent itself.","example":"The homepage loaded correctly and all assertions passed.","nullable":true},"prompt":{"type":"string","description":"The prompt that was executed for this run.","nullable":true},"assertions":{"$ref":"#/components/schemas/Model55"},"suggestions":{"$ref":"#/components/schemas/suggestions"},"steps":{"$ref":"#/components/schemas/steps"},"errors":{"$ref":"#/components/schemas/Model58"},"artifactManifest":{"$ref":"#/components/schemas/artifactManifest"}}},"resultType":{"type":"string","description":"The type of result. FINAL means this is the final result of the check run. ATTEMPT means this is a result of a double check attempt.","example":"FINAL","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"errorGroupIds":{"type":"array","description":"IDs of the error groups associated with this check result. Always an array: empty when the result has no associated error groups, single-element when there is one (typical for API/URL/TCP/ICMP checks), or multi-element for Playwright and multistep checks that can produce multiple distinct errors per run. Use these IDs to fetch the corresponding error group via the error-groups endpoint.","example":["883af87b-ac7c-44e3-9376-b4bece04e788"],"nullable":true,"items":{"type":"string","x-format":{"guid":true}}},"CheckResult":{"type":"object","properties":{"id":{"type":"string","description":"The unique ID of this result."},"name":{"type":"string","description":"The name of the check."},"checkId":{"type":"string","description":"The ID of the check."},"hasFailures":{"type":"boolean","description":"Describes if any failure has occurred during this check run. This is should be your mainmain focus for assessing API or browser check behaviour. Assertions that fail, timeouts or failing scripts all resolve tothis value being true."},"hasErrors":{"type":"boolean","description":"Describes if an internal error has occured in Checkly's backend. This should be false in almost all cases."},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","nullable":true},"isCancelled":{"type":"boolean","description":"Whether the run was cancelled before completion."},"overMaxResponseTime":{"type":"boolean","description":"Set to true if the response time is over the limit set by the \"maxResponseTime\" field on the check. Applies only to API checks.","nullable":true},"runLocation":{"type":"string","description":"What data center location this check result originated from."},"startedAt":{"type":"string","format":"date-time","nullable":true},"stoppedAt":{"type":"string","format":"date-time","nullable":true},"created_at":{"type":"string","format":"date-time"},"responseTime":{"type":"number","description":"Describes the time it took to execute relevant parts of this check. Any setup timeor system time needed to start executing this check in the Checkly backend is not part of this."},"apiCheckResult":{"$ref":"#/components/schemas/CheckResultAPI"},"browserCheckResult":{"$ref":"#/components/schemas/CheckResultBrowser"},"multiStepCheckResult":{"$ref":"#/components/schemas/MultiStepResultBrowser"},"agenticCheckResult":{"$ref":"#/components/schemas/CheckResultAgentic"},"checkRunId":{"type":"number","description":"The id of the specific check run that created this check result."},"attempts":{"type":"number","description":"How often this check was retried. This will be larger than 0 when double checking is enabled."},"resultType":{"$ref":"#/components/schemas/resultType"},"sequenceId":{"type":"string","description":"The sequence ID of the check run. This is used to group check runs with multiple attempts together.","example":"2dbfa2a3-5477-45ea-ac33-ee55b8ea66ff","nullable":true,"x-format":{"guid":true}},"errorGroupIds":{"$ref":"#/components/schemas/errorGroupIds"}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model59":{"type":"array","x-constraint":{"single":true},"items":{"type":"string"}},"matchTags":{"type":"array","description":"Match checks with the given tags. Group tags also match.\n\nThe value is a two-dimensional array. The top level array defines `OR` conditions, and the second level `AND` conditions. Tags can also be prefixed with `!` to only match checks without those tags.\n\nExample: `[[a, b], [a, c, !d]]` means `(a && b) || (a && c && !d)`.","example":[["production","!skip-e2e"]],"items":{"$ref":"#/components/schemas/Model59"}},"checkId":{"type":"array","description":"Match checks with the given identifiers.","example":["a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a"],"x-constraint":{"single":true},"items":{"type":"string","x-format":{"guid":true}}},"TriggerCheckSessionTarget":{"type":"object","properties":{"matchTags":{"$ref":"#/components/schemas/matchTags"},"checkId":{"$ref":"#/components/schemas/checkId"}}},"TriggerCheckSessionRequestPayload":{"type":"object","properties":{"target":{"$ref":"#/components/schemas/TriggerCheckSessionTarget"},"refreshCache":{"type":"boolean","description":"If true, the runner will skip existing caches and install dependencies from scratch. This applies only to Playwright Check Suites.","default":false}}},"Model60":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model61":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"runSource":{"type":"string","description":"The source that triggered the check session.","example":"TRIGGER_API","enum":["CLI_DEPLOY","DEPLOYMENT","DEPLOYMENT_CACHE_WARMER","EDITOR","GROUP_RUN_ALL","LEGACY_TRIGGER","SCHEDULER","SCHEDULE_NOW","SLACK_RERUN","TEST_NO_RECORD","TEST_RECORD","TRIGGER_NO_RECORD","TRIGGER_RECORD","TRIGGER_API"],"nullable":true},"CheckSession":{"type":"object","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model60"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model61"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"sessions":{"type":"array","description":"A list of check sessions, with one check session for each check.","items":{"$ref":"#/components/schemas/CheckSession"}},"TriggerCheckSessionResponse":{"type":"object","description":"Returns a check session for each check matching target conditions.","properties":{"sessions":{"$ref":"#/components/schemas/sessions"}},"required":["sessions"]},"NoMatchingChecksFoundErrorResponse":{"type":"object","description":"Returned when there are no matching checks.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No matching checks were found."}},"required":["statusCode"]},"Model62":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model63":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT","CANCELLED"]},"Model64":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model65":{"type":"string","description":"The type of the result.","example":"FINAL","enum":["FINAL","ATTEMPT","ALL"],"nullable":true},"CheckSessionConciseCheckResult":{"type":"object","properties":{"checkResultId":{"type":"string","description":"The ID of the check result.","example":"22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"guid":true}},"checkResultLink":{"type":"string","description":"A link to the check result.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8/results/22be3b52-5ec2-4894-9086-b5b4a8b00a89","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model64"},"name":{"type":"string","example":"Example API Check"},"runLocation":{"type":"string","description":"The location where the check ran.","example":"us-east-1"},"resultType":{"$ref":"#/components/schemas/Model65"},"hasErrors":{"type":"boolean","description":"Whether the result has errors.","example":false},"hasFailures":{"type":"boolean","description":"Whether the result has failures.","example":false},"isDegraded":{"type":"boolean","description":"Whether the result is degraded.","example":false},"aborted":{"type":"boolean","description":"Whether the check was aborted.","example":false},"isCancelled":{"type":"boolean","description":"Whether the check was cancelled before completion.","example":false}},"required":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted","isCancelled"]},"results":{"type":"array","description":"The results of the check session. Only partial results are available until the check session has completed.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"FindOneCheckSessionResponse":{"type":"object","description":"The current state of the check session.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model62"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model63"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z","nullable":true},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/results"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","timeElapsed","runLocations"]},"CheckSessionNotFoundErrorResponse":{"type":"object","description":"No such check session exists.","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"type":"string","example":"Not Found"},"message":{"type":"string","example":"No such check session."}},"required":["statusCode"]},"Model66":{"type":"string","example":"API","enum":["AGENTIC","API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model67":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT","CANCELLED"]},"Model68":{"type":"array","description":"The results of the check session.","items":{"$ref":"#/components/schemas/CheckSessionConciseCheckResult"}},"AwaitCheckSessionCompletionResponse":{"type":"object","description":"Returned when the check session has finished running.","properties":{"checkSessionId":{"type":"string","description":"The unique identifier of the check session.","example":"8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"guid":true}},"checkSessionLink":{"type":"string","description":"A link to the check session.","example":"https://app.checklyhq.com/accounts/1397c172-1938-4973-a225-5862298e571a/checks/a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a/check-sessions/8166fa86-c9b4-4162-8541-d380c6c212d8","x-format":{"uri":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"a4cd4ad9-4815-4a9e-92d2-0a7c562ee69a","x-format":{"guid":true}},"checkType":{"$ref":"#/components/schemas/Model66"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model67"},"startedAt":{"type":"string","format":"date-time","description":"The date and time when the session started.","example":"2025-08-28T18:23:40.262Z"},"stoppedAt":{"type":"string","format":"date-time","description":"The date and time when the session stopped.","example":"2025-08-28T18:28:40.993Z"},"timeElapsed":{"type":"number","description":"The time the check session took, in milliseconds.","example":300731},"runLocations":{"$ref":"#/components/schemas/runLocations"},"runSource":{"$ref":"#/components/schemas/runSource"},"results":{"$ref":"#/components/schemas/Model68"}},"required":["checkSessionId","checkSessionLink","checkId","checkType","status","startedAt","stoppedAt","timeElapsed","runLocations"]},"AwaitCheckSessionCompletionTryAgainResponse":{"type":"object","description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","properties":{"statusCode":{"type":"number","enum":[408]},"error":{"type":"string","example":"Request Time-out"},"message":{"type":"string","example":"Check session is still in progress, but maximum per-request wait time was exceeded. Please retry."}},"required":["statusCode"]},"CheckStatus":{"type":"object","nullable":true,"properties":{"name":{"type":"string","description":"The name of the check.","example":"API Check"},"checkId":{"type":"string","description":"The ID of check this status belongs to.","example":"1008ca04-d3ca-41fa-b477-9e99b761dbb4"},"hasFailures":{"type":"boolean","description":"Describes if this check is currently failing. If any of the assertions for an API checkfail this value is true. If a browser check fails for whatever reason, this is true.","example":false},"hasErrors":{"type":"boolean","description":"Describes if due to some error outside of normal operation this check is failing. This should be extremely rare and only when there is an error in the Checkly backend.","example":false},"isDegraded":{"type":"boolean","description":"A check is degraded if it is over the degradation limit set by the \"degradedResponseTime\" field on the check. Applies only to API checks.","example":true},"longestRun":{"type":"number","description":"The longest ever recorded response time for this check.","example":10,"nullable":true},"shortestRun":{"type":"number","description":"The shortest ever recorded response time for this check.","example":5,"nullable":true},"lastRunLocation":{"type":"string","description":"What location this check was last run at.","example":"us-east-1","nullable":true},"lastCheckRunId":{"type":"string","description":"The unique incrementing ID for each check run.","example":"f10d711f-cd16-4303-91ce-741c92586b4a","nullable":true},"sslDaysRemaining":{"type":"number","description":"How many days remain till the current SSL certificate expires.","example":3,"nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"CheckStatusList":{"type":"array","items":{"$ref":"#/components/schemas/CheckStatus"}},"Check":{"type":"object","properties":{"id":{"type":"string"},"checkType":{"$ref":"#/components/schemas/checkType"}},"required":["checkType"]},"CheckList":{"type":"array","items":{"$ref":"#/components/schemas/Check"}},"Model69":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"CheckLocationList":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model69"}},"CheckTagList":{"type":"array","description":"Tags for organizing and filtering checks.","example":["production"],"items":{"type":"string"}},"CheckAlertSettings":{"type":"object","description":"Alert settings.","default":{"escalationType":"RUN_BASED","runBasedEscalation":{"failedRunThreshold":1},"reminders":{"amount":0,"interval":5},"parallelRunFailureThreshold":{"enabled":false,"percentage":10}},"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/escalationType"},"reminders":{"$ref":"#/components/schemas/AlertSettingsReminders"},"sslCertificates":{"$ref":"#/components/schemas/AlertSettingsSSLCertificates"},"runBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsRunBasedEscalation"},"timeBasedEscalation":{"$ref":"#/components/schemas/AlertSettingsTimeBasedEscalation"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/parallelRunFailureThreshold"}}},"Model70":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model71":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"severity":{"type":"string","description":"The severity level of the incident.","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"TriggerIncident":{"type":"object","description":"Determines whether the check or monitor should create and resolve an incident based on its alert configuration. Useful for status page automation.","nullable":true,"properties":{"serviceId":{"type":"string","description":"The status page service that the incident will be associated with.","x-format":{"guid":true}},"severity":{"$ref":"#/components/schemas/severity"},"name":{"type":"string","description":"The name of the incident."},"description":{"type":"string","description":"A detailed description of the incident."},"notifySubscribers":{"type":"boolean","description":"Whether to notify subscribers when the incident is triggered."}},"required":["serviceId","severity","name","description","notifySubscribers"]},"CheckRequest":{"type":"object"},"heartbeat":{"type":"object"},"EnvironmentVariable":{"type":"object","properties":{"key":{"type":"string","description":"The key of the environment variable (this value cannot be changed).","example":"API_KEY"},"value":{"type":"string"},"locked":{"type":"boolean","description":"Used only in the UI to hide the value like a password.","default":false},"secret":{"type":"boolean","description":"Set an environment variable as secret. Once set, its value cannot be unlocked.","default":false}},"required":["key","value"]},"CheckEnvironmentVariableList":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. These are only relevant for Browser checks. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckDependency":{"type":"object","properties":{"path":{"type":"string","maxLength":1000},"content":{"type":"string"}},"required":["path","content"]},"CheckDependencyList":{"type":"array","description":"An array of BCR dependency files.","nullable":true,"items":{"$ref":"#/components/schemas/CheckDependency"}},"CheckCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/CheckLocationList"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model70"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model71"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","checkType","heartbeat","script"]},"Model72":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model73":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model72"}},"Model74":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model75":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"method":{"type":"string","default":"GET","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"]},"ipFamily":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"]},"bodyType":{"type":"string","default":"NONE","enum":["JSON","FORM","RAW","GRAPHQL","NONE"]},"Model76":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model77":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Request":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model76"},"queryParameters":{"$ref":"#/components/schemas/Model77"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPICreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model73"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model74"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model75"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Request"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name","request"]},"Model78":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model79":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model78"}},"Model80":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"CheckAlertChannelSubscription":{"type":"object","properties":{"alertChannelId":{"type":"number"},"activated":{"type":"boolean","default":true}},"required":["alertChannelId","activated"]},"CheckAlertChannelSubscriptionList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertChannelSubscription"}},"CheckAlertEmail":{"type":"object","properties":{"address":{"type":"string","default":""}},"required":["address"]},"CheckAlertEmailList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertEmail"}},"Model81":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model82":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model83":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model81"},"headers":{"$ref":"#/components/schemas/Model82"},"queryParameters":{"$ref":"#/components/schemas/Model83"}},"required":["url"]},"CheckAlertWebhookList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertWebhook"}},"CheckAlertSlack":{"type":"object","properties":{"url":{"type":"string","default":""}},"required":["url"]},"CheckAlertSlackList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSlack"}},"CheckAlertSMS":{"type":"object","properties":{"number":{"type":"string","example":"+549110000000","default":""},"name":{"type":"string","example":"SMS Alert"}},"required":["number","name"]},"CheckAlertSMSList":{"type":"array","items":{"$ref":"#/components/schemas/CheckAlertSMS"}},"CheckAlertChannels":{"type":"object","nullable":true,"properties":{"email":{"$ref":"#/components/schemas/CheckAlertEmailList"},"webhook":{"$ref":"#/components/schemas/CheckAlertWebhookList"},"slack":{"$ref":"#/components/schemas/CheckAlertSlackList"},"sms":{"$ref":"#/components/schemas/CheckAlertSMSList"}}},"Model84":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model85":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model86":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model84"},"queryParameters":{"$ref":"#/components/schemas/Model85"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model87":{"type":"string","enum":["API"]},"CheckAPI":{"type":"object","properties":{"id":{"type":"string","example":"2739d22d-086f-481d-a484-8b93ac84de61"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model79"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model80"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model86"},"checkType":{"$ref":"#/components/schemas/Model87"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}},"required":["name"]},"Model88":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model89":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model88"}},"Model90":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model91":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model92":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model93":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model94":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/method"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"body":{"type":"string","default":""},"bodyType":{"$ref":"#/components/schemas/bodyType"},"headers":{"$ref":"#/components/schemas/Model92"},"queryParameters":{"$ref":"#/components/schemas/Model93"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"CheckAPIUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model89"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model90"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model91"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model94"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","example":null,"default":null,"nullable":true},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","example":"","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","example":"","default":null,"nullable":true}}},"Model95":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model96":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model95"}},"Model97":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model98":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model99":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model96"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model97"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model98"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model99"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}},"required":["name","script"]},"Model100":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model101":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model100"}},"Model102":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model103":{"type":"string","enum":["BROWSER"]},"Model104":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowser":{"type":"object","properties":{"id":{"type":"string","example":"e435c01a-0d6c-4cc4-baae-a5c12961aa69"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model101"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model102"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model103"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","nullable":true},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"environmentVariables":{"$ref":"#/components/schemas/Model104"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model105":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model106":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model105"}},"Model107":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model108":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model109":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckBrowserUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model106"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model107"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model108"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"environmentVariables":{"$ref":"#/components/schemas/Model109"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a browser interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"},"sslCheckDomain":{"type":"string","description":"A valid fully qualified domain name (FQDN) to check its SSL certificate.","example":"www.acme.com","nullable":true}}},"Model110":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model111":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model110"}},"Model112":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model113":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"recordType":{"type":"string","enum":["A","AAAA","CNAME","MX","TXT","SOA","NS"]},"DnsMonitorAssertionSource":{"type":"string","enum":["RESPONSE_TIME","RESPONSE_CODE","TEXT_ANSWER","JSON_ANSWER"]},"DnsMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","HAS_KEY","NOT_HAS_KEY","HAS_VALUE","NOT_HAS_VALUE","IS_EMPTY","NOT_EMPTY","GREATER_THAN","LESS_THAN","CONTAINS","NOT_CONTAINS","IS_NULL","NOT_NULL"]},"Model114":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/DnsMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/DnsMonitorAssertionComparison"}}},"DnsMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"RESPONSE_CODE","comparison":"EQUALS","target":"NOERROR"}],"items":{"$ref":"#/components/schemas/Model114"}},"protocol":{"type":"string","default":"UDP","enum":["TCP","UDP"]},"DnsMonitorRequest":{"type":"object","description":"Determines the request that the DNS monitor is going to run.","properties":{"query":{"type":"string","example":"api.checklyhq.com","maxLength":100},"nameServer":{"type":"string","maxLength":100},"port":{"type":"number"},"recordType":{"$ref":"#/components/schemas/recordType"},"assertions":{"$ref":"#/components/schemas/DnsMonitorAssertionList"},"protocol":{"$ref":"#/components/schemas/protocol"}},"required":["query","recordType"]},"CheckDNSCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model111"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model112"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model113"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":500,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":1000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model115":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model116":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model115"}},"Model117":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model118":{"type":"string","enum":["DNS"]},"MonitorDNS":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model116"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model117"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model118"}},"required":["name"]},"Model119":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model120":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model119"}},"Model121":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model122":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model123":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model120"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model121"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model122"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model123"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["name","heartbeat","script"]},"Model124":{"type":"string","enum":["HEARTBEAT"]},"Model125":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}},"pingUrl":{"type":"string","example":"https://ping.checklyhq.com/22868839-8450-4010-9241-1ea83a2e425f"}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeat":{"type":"object","properties":{"id":{"type":"string","example":"d432cf89-010b-4b12-8150-958c8eb1d5ca"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model124"},"heartbeat":{"$ref":"#/components/schemas/Model125"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model126":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model127":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model126"}},"Model128":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model129":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model130":{"type":"object","properties":{"period":{"type":"number","description":"Interval expected between pings."},"periodUnit":{"$ref":"#/components/schemas/periodUnit"},"grace":{"type":"number","description":"Grace added to the period."},"graceUnit":{"$ref":"#/components/schemas/graceUnit"},"pingToken":{"type":"string","description":"UUID token used to build a unique ping URL.","nullable":true,"x-format":{"guid":true}}},"required":["period","periodUnit","grace","graceUnit"]},"CheckHeartbeatUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model127"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model128"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model129"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/Model130"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000}},"required":["script"]},"successRatio":{"type":"object","properties":{"previousPeriod":{"type":"number"},"currentPeriod":{"type":"number"}}},"Model131":{"type":"object","nullable":true,"properties":{"successRatio":{"$ref":"#/components/schemas/successRatio"},"totalEntitiesCurrentPeriod":{"type":"number"}}},"state":{"type":"string","description":"Describe the event state, if the ping was received or not.","example":"FAILING","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]},"Model132":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"state":{"$ref":"#/components/schemas/state"},"timestamp":{"type":"string","format":"date","description":"UTC timestamp on which we received the event.","example":"2023-07-24T10:01:01.098Z"},"source":{"type":"string","description":"Source which triggered the event.","example":"HTTPS GET from Curl","nullable":true},"userAgent":{"type":"string","description":"User agent from the ping.","example":"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/89.0.4389.82 Safari/537.36","nullable":true}},"required":["id"]},"events":{"type":"array","items":{"$ref":"#/components/schemas/Model132"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model131"},"last7Days":{"$ref":"#/components/schemas/Model131"}}},"Model133":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model134":{"type":"array","items":{"$ref":"#/components/schemas/Model133"}},"Model135":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model132"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model136":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model137":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model136"}},"Model138":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model139":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model140":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_RESPONSE"]},"Model141":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"type":"string"},"property":{"type":"string"},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}},"required":["property"]},"IcmpMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions.","example":[{"source":"LATENCY","property":"avg","comparison":"LESS_THAN","target":"100"}],"items":{"$ref":"#/components/schemas/Model141"}},"IcmpMonitorRequest":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model140"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model137"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model138"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model139"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request","heartbeat","script"]},"Model142":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model143":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model142"}},"Model144":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model145":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model146":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model145"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"Model147":{"type":"string","enum":["ICMP"]},"MonitorICMP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model143"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model144"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"degradedPacketLossThreshold":{"type":"number","nullable":true},"maxPacketLossThreshold":{"type":"number","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model146"},"checkType":{"$ref":"#/components/schemas/Model147"}},"required":["name"]},"Model148":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model149":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model148"}},"Model150":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model151":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model152":{"type":"string","default":"IPv4","enum":["IPv4","IPv6"],"nullable":true},"Model153":{"type":"object","description":"Determines the request that the ICMP monitor is going to run.","properties":{"hostname":{"type":"string","example":"api.checklyhq.com","maxLength":2048},"ipFamily":{"$ref":"#/components/schemas/Model152"},"pingCount":{"type":"integer","default":10,"nullable":true,"minimum":1,"maximum":50},"assertions":{"$ref":"#/components/schemas/IcmpMonitorAssertionList"}},"required":["hostname"]},"IcmpMonitorUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model149"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model150"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model151"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/Model153"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":10000,"nullable":true,"minimum":0,"maximum":300000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":20000,"nullable":true,"minimum":0,"maximum":300000},"degradedPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for degraded state. Must be greater than 0.","default":10,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"maxPacketLossThreshold":{"type":"number","description":"The packet loss percentage threshold for failed state. Must be greater than 0 and greater than or equal to degradedPacketLossThreshold.","default":20,"nullable":true,"maximum":100,"x-constraint":{"greater":0}},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["heartbeat","script"]},"Model154":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model155":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model154"}},"Model156":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model157":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model158":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model159":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model160":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model155"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model156"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model157"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model158"},"environmentVariables":{"$ref":"#/components/schemas/Model159"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model160"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model161":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model162":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model161"}},"Model163":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model164":{"type":"string","enum":["MULTI_STEP"]},"Model165":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"CheckMultiStep":{"type":"object","properties":{"id":{"type":"string","example":"b9972e6a-5579-4080-b1d8-0e43f4847b82"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model162"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model163"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model164"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"environmentVariables":{"$ref":"#/components/schemas/Model165"}},"required":["name","script"]},"Model166":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model167":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model166"}},"Model168":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model169":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model170":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model171":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":100,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model172":{"type":"array","description":"An array of one or more private locations where to run the check.","example":[],"nullable":true,"items":{"type":"string"}},"CheckMultiStepUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model167"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model168"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model169"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/Model170"},"environmentVariables":{"$ref":"#/components/schemas/Model171"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[1,2,5,10,15,30,60,120,180,360,720,1440]},"script":{"type":"string","description":"A valid piece of Node.js javascript code describing a multi-step API interaction with the Playwright frameworks.","example":"const { chromium } = require(\"playwright\");\n(async () => {\n\n // launch the browser and open a new page\n const browser = await chromium.launch();\n const page = await browser.newPage();\n\n // navigate to our target web page\n await page.goto(\"https://danube-webshop.herokuapp.com/\");\n\n // click on the login button and go through the login procedure\n await page.click(\"#login\");\n await page.type(\"#n-email\", \"user@email.com\");\n await page.type(\"#n-password2\", \"supersecure1\");\n await page.click(\"#goto-signin-btn\");\n\n // wait until the login confirmation message is shown\n await page.waitForSelector(\"#login-message\", { visible: true });\n\n // close the browser and terminate the session\n await browser.close();\n})();","nullable":true},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model172"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model173":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model174":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model173"}},"Model175":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model176":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model177":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model177"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model178":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model179":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model178"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model174"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model175"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model176"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model179"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model180":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model181":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model180"}},"Model182":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model183":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model184":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model183"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model185":{"type":"string","enum":["TCP"]},"CheckTCP":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model181"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model182"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model184"},"checkType":{"$ref":"#/components/schemas/Model185"}},"required":["name"]},"Model186":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model187":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model186"}},"Model188":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model189":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model190":{"type":"array","description":"Check the main Checkly documentation on assertions for specific values like regular expressions and JSON path descriptors you can use in the \"property\" field.","example":[{"source":"TEXT_BODY","comparison":"NOT_EMPTY","target":"200"}],"items":{"$ref":"#/components/schemas/TcpCheckAssertion"}},"Model191":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model190"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"CheckTCPUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model187"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model188"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model189"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model191"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":5000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":5000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model192":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model193":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model192"}},"Model194":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model195":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model196":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model197":{"type":"object","properties":{"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true},"source":{"$ref":"#/components/schemas/UlrMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/UrlMonitorAssertionComparison"}}},"UrlMonitorAssertionList":{"type":"array","description":"Check the main Checkly documentation on assertions, for URL checks only status code is supported.","example":[{"source":"STATUS_CODE","comparison":"EQUALS","target":"200"}],"items":{"$ref":"#/components/schemas/Model197"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model196"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model193"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model194"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model195"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/UrlMonitorRequest"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}},"required":["name","request"]},"Model198":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model199":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model198"}},"Model200":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model201":{"type":"string","default":"GET","enum":["GET"]},"Model202":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model201"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"Model203":{"type":"string","enum":["URL"]},"CheckURL":{"type":"object","properties":{"id":{"type":"string","example":"9d6df684-0bc3-4a38-a094-4e97627dd93e"},"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model199"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model200"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/CheckAlertChannelSubscriptionList"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","nullable":true},"maxResponseTime":{"type":"number","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"request":{"$ref":"#/components/schemas/Model202"},"checkType":{"$ref":"#/components/schemas/Model203"}},"required":["name"]},"Model204":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model205":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model204"}},"Model206":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model207":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model208":{"type":"string","default":"GET","enum":["GET"]},"Model209":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model208"},"url":{"type":"string","default":"https://api.checklyhq.com","maxLength":2048},"followRedirects":{"type":"boolean"},"skipSSL":{"type":"boolean","default":false},"ipFamily":{"$ref":"#/components/schemas/ipFamily"},"assertions":{"$ref":"#/components/schemas/UrlMonitorAssertionList"}},"required":["url"]},"CheckURLUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model205"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/AlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model206"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model207"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"request":{"$ref":"#/components/schemas/Model209"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10,"enum":[0,1,2,5,10,15,30,60,120,180,360,720,1440]},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API & TCP checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"degradedResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered degraded.","default":3000,"nullable":true,"minimum":0,"maximum":30000},"maxResponseTime":{"type":"number","description":"The response time in milliseconds where a check should be considered failing.","default":5000,"nullable":true,"minimum":0,"maximum":30000},"privateLocations":{"$ref":"#/components/schemas/privateLocations"}}},"Model210":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model211":{"type":"array","description":"An array of one or more data center locations where to run this check.","example":["us-east-1","eu-central-1"],"nullable":true,"items":{"$ref":"#/components/schemas/Model210"}},"Model212":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model213":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"CheckUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check.","example":"Check"},"activated":{"type":"boolean","description":"Determines if the check is running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check fails and/or recovers.","default":false},"doubleCheck":{"type":"boolean","description":"[Deprecated] Retry failed check runs. This property is deprecated, and `retryStrategy` can be used instead.","default":true},"shouldFail":{"type":"boolean","description":"Allows to invert the behaviour of when a check is considered to fail. Allows for validating error status like 404.","default":false},"locations":{"$ref":"#/components/schemas/Model211"},"tags":{"$ref":"#/components/schemas/CheckTagList"},"alertSettings":{"$ref":"#/components/schemas/CheckAlertSettings"},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the account level alert setting will be used, not the alert setting defined on this check.","default":true},"groupId":{"type":"number","description":"The id of the check group this check is part of.","example":null,"default":null,"nullable":true},"groupOrder":{"type":"number","description":"The position of this check in a check group. It determines in what order checks are run when a group is triggered from the API or from CI/CD.","example":null,"default":null,"nullable":true,"minimum":0},"runtimeId":{"$ref":"#/components/schemas/Model212"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model213"},"retryStrategy":{"$ref":"#/components/schemas/RetryStrategy"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"description":{"type":"string","description":"A description of the check.","default":null,"nullable":true,"maxLength":500},"checkType":{"$ref":"#/components/schemas/checkType"},"frequency":{"type":"integer","description":"How often the check should run in minutes.","default":10},"frequencyOffset":{"type":"integer","description":"Used for setting seconds for check frequencies under 1 minutes (only for API checks) and spreading checks over a time range for frequencies over 1 minute. This works as follows: Checks with a frequency of 0 can have a frequencyOffset of 10, 20 or 30 meaning they will run every 10, 20 or 30 seconds. Checks with a frequency lower than and equal to 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.floor(frequency * 10)\", i.e. for a check that runs every 5 minutes the max frequencyOffset is 50. Checks with a frequency higher than 60 can have a frequencyOffset between 1 and a max value based on the formula \"Math.ceil(frequency / 60)\", i.e. for a check that runs every 720 minutes, the max frequencyOffset is 12. ","minimum":1},"request":{"$ref":"#/components/schemas/CheckRequest"},"heartbeat":{"$ref":"#/components/schemas/heartbeat"},"script":{"type":"string"},"scriptPath":{"type":"string","description":"Path of the script in the runtime.","nullable":true},"sslCheckDomain":{"type":"string"},"environmentVariables":{"$ref":"#/components/schemas/CheckEnvironmentVariableList"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check.","default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check.","default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase.","default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase.","default":null,"nullable":true},"degradedResponseTime":{},"maxResponseTime":{},"privateLocations":{"$ref":"#/components/schemas/privateLocations"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["heartbeat","script"]},"ClientCertificateRetrieve":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time"}},"required":["host","cert","id"]},"ClientCertificateList":{"type":"array","items":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}},"ClientCertificateCreate":{"type":"object","properties":{"host":{"type":"string","description":"The host domain for the certificate without https://. You can use wildcards to match domains, e.g. \"*.acme.com\"","example":"www.acme.com"},"cert":{"type":"string","description":"The client certificate in PEM format as a string. This string should retain any line breaks, e.g. it should start similar to this \"-----BEGIN CERTIFICATE-----\\nMIIEnTCCAoWgAwIBAgIJAL+WugL..."},"ca":{"type":"string","description":"An optional CA certificate in PEM format as a string.","nullable":true},"key":{"type":"string","description":"The private key in PEM format as a string."},"passphrase":{"type":"string","description":"An optional passphrase for the private key. Your passphrase is stored encrypted at rest.","nullable":true}},"required":["host","cert"]},"width":{"type":"string","description":"Determines whether to use the full screen or focus in the center.","default":"FULL","enum":["FULL","960PX"]},"DashboardTagList":{"type":"array","description":"A list of one or more tags that filter which checks to display on the dashboard.","example":["production"],"items":{"type":"string"}},"DashboardKey":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"rawKey":{"type":"string","example":"da_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"keys":{"type":"array","description":"Show key for private dashboard.","items":{"$ref":"#/components/schemas/DashboardKey"}},"Dashboard":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"id":{"type":"number"},"dashboardId":{"type":"string","example":"1"},"created_at":{"type":"string","format":"date-time"},"header":{"type":"string","nullable":true}},"required":["id","dashboardId","created_at"]},"DashboardsList":{"type":"array","items":{"$ref":"#/components/schemas/Dashboard"}},"DashboardCreate":{"type":"object","properties":{"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"}},"required":["header"]},"Model214":{"type":"object","properties":{"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","example":"https://status.mycompany.com/","nullable":true},"customUrl":{"type":"string","description":"A subdomain name under \"checklyhq.com\". Needs to be unique across all users.","example":"status"},"logo":{"type":"string","description":"A URL pointing to an image file.","example":"https://static.mycompany.com/static/images/logo.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","description":"A URL pointing to an image file used as dashboard favicon.","example":"https://static.mycompany.com/static/images/icon.svg","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"description":{"type":"string","description":"A piece of text displayed below the header or title of your dashboard.","example":"My dashboard description","nullable":true},"width":{"$ref":"#/components/schemas/width"},"refreshRate":{"type":"number","description":"How often to refresh the dashboard in seconds.","default":60,"enum":[60,300,600]},"paginate":{"type":"boolean","description":"Determines of pagination is on or off.","default":true},"paginationRate":{"type":"number","description":"How often to trigger pagination in seconds.","default":60,"enum":[30,60,300]},"checksPerPage":{"type":"number","description":"Number of checks displayed per page.","default":15,"nullable":true,"minimum":1,"maximum":20},"useTagsAndOperator":{"type":"boolean","description":"When to use AND operator for tags lookup.","default":false,"nullable":true},"hideTags":{"type":"boolean","description":"Show or hide the tags on the dashboard.","default":false},"enableIncidents":{"type":"boolean","description":"Enable or disable incidents on the dashboard.","default":false},"expandChecks":{"type":"boolean","description":"Expand or collapse checks on the dashboard.","default":false},"tags":{"$ref":"#/components/schemas/DashboardTagList"},"showHeader":{"type":"boolean","description":"Show or hide header and description on the dashboard.","default":true},"showCheckRunLinks":{"type":"boolean","description":"Show or hide check run links on the dashboard.","default":false},"showGroupNames":{"type":"boolean","description":"Show or hide group names on the dashboard.","default":true},"customCSS":{"type":"string","description":"Custom CSS to be applied to the dashboard.","default":"","nullable":true},"isPrivate":{"type":"boolean","description":"Determines if the dashboard is public or private.","default":false},"showP95":{"type":"boolean","description":"Show or hide the P95 stats on the dashboard.","default":true},"showP99":{"type":"boolean","description":"Show or hide the P99 stats on the dashboard.","default":true},"keys":{"$ref":"#/components/schemas/keys"},"header":{"type":"string","description":"A piece of text displayed at the top of your dashboard.","example":"My company status"}}},"rootCauseAnalyses":{"type":"array","items":{"$ref":"#/components/schemas/attributes"}},"Model215":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model215"}},"ErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"checkId":{"type":"string"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a check result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"impact":{"type":"string","description":"Used to indicate the impact or severity.","example":"MINOR","default":"MINOR","enum":["MAINTENANCE","MAJOR","MINOR"]},"Model216":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model217":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model216"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["status","description"]},"incidentUpdates":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"status":"INVESTIGATING","description":"The service is down and affects all the regions."}],"x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/Model217"}},"Model218":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"incidentUpdates":{"$ref":"#/components/schemas/incidentUpdates"}},"required":["name","impact","dashboardId","incidentUpdates"]},"Model219":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model220":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model219"},"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."},"id":{"type":"string","description":"The incident update universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident update was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when last the update.","example":"2022-09-08T20:41:28.658Z","nullable":true}},"required":["status","description","id","created_at","updated_at"]},"Model221":{"type":"array","description":"The first incident update with the status and description. It must be only one element.","example":[{"id":"01f477f8-4293-4e1c-82bd-99797720434c","status":"RESOLVED","description":"The service is up and all is recovered.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T20:56:48.425Z","updated_at":null},{"id":"1f0640f8-1910-4137-b91d-ed152faa92e6","status":"INVESTIGATING","description":"The service is down and affects all the regions.","incidentId":"3abcfdfe-ae2d-4632-8dd1-18dd871e18fc","created_at":"2022-09-08T18:56:48.425Z","updated_at":null}],"minItems":1,"items":{"$ref":"#/components/schemas/Model220"}},"Model222":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/Model221"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model223":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true}},"required":["name","impact"]},"Model224":{"type":"object","properties":{"name":{"type":"string","description":"A name used to describe the incident.","example":"Service outage"},"impact":{"$ref":"#/components/schemas/impact"},"startedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident starts to be active.","example":"2022-11-25T12:34:56.000Z","nullable":true},"stoppedAt":{"type":"string","format":"date-time","description":"Used to indicate when incident turns to inactive.","example":"2022-11-25T13:34:56.000Z","nullable":true},"dashboardId":{"type":"number","description":"The dashboard ID where the incident will be shown.","example":1234},"id":{"type":"string","description":"The incident universal and unique identificator.","example":"e50ad839-1b90-4955-b716-1c6edbda57cb","x-format":{"guid":true}},"created_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was created.","example":"2022-09-08T19:41:28.658Z"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when the incident was last updated.","example":"2022-09-08T20:41:28.658Z","nullable":true},"incidentUpdates":{"type":"string","nullable":true}},"required":["name","impact","dashboardId","id","created_at","updated_at"]},"IncidentResults":{"type":"array","items":{"$ref":"#/components/schemas/Model220"}},"Model225":{"type":"object","properties":{"description":{"type":"string","description":"A description about the status update.","example":"We found the issue and we are working on it."}},"required":["description"]},"Model226":{"type":"object","properties":{"region":{"type":"string","description":"The unique identifier of this location.","example":"us-east-1"},"name":{"type":"string","description":"Friendly name of this location.","example":"N. Virginia"}},"required":["region","name"]},"LocationList":{"type":"array","items":{"$ref":"#/components/schemas/Model226"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"items":{"type":"string"}},"silenceAlertsTags":{"type":"array","description":"Tags defining which checks have alerts silenced (when silenceAllAlerts is false).","items":{"type":"string"}},"MaintenanceWindow":{"type":"object","properties":{"id":{"type":"number","description":"The id of the maintenance window.","example":1},"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false},"created_at":{"type":"string","format":"date","description":"The creation date of the maintenance window."},"updated_at":{"type":"string","format":"date","description":"The last date that the maintenance window was updated.","nullable":true}},"required":["id","name","startsAt","endsAt","repeatUnit","created_at","updated_at"]},"MaintenanceWindowList":{"type":"array","items":{"$ref":"#/components/schemas/MaintenanceWindow"}},"MaintenanceWindowCreate":{"type":"object","properties":{"name":{"type":"string","description":"The maintenance window name.","example":"Maintenance Window","maxLength":200},"tags":{"$ref":"#/components/schemas/MaintenanceWindowTagList"},"startsAt":{"type":"string","format":"date","description":"The start date of the maintenance window.","example":"2022-08-24"},"endsAt":{"type":"string","format":"date","description":"The end date of the maintenance window.","example":"2022-08-25"},"repeatInterval":{"type":"number","description":"The repeat interval of the maintenance window from the first occurance.","example":null,"default":null,"nullable":true,"minimum":1},"repeatUnit":{"type":"string","description":"The repeat strategy for the maintenance window.","example":"DAY"},"repeatEndsAt":{"type":"string","format":"date","description":"The end date where the maintenance window should stop repeating.","example":null,"nullable":true},"pauseAllChecks":{"type":"boolean","description":"Whether to pause all checks in the account (overrides tag scope).","default":false},"silenceAlertsTags":{"$ref":"#/components/schemas/silenceAlertsTags"},"silenceAllAlerts":{"type":"boolean","description":"Whether to silence alerts for all checks (overrides silenceAlertsTags scope).","default":false}},"required":["name","startsAt","endsAt","repeatUnit"]},"privateLocationKeys":{"type":"object","properties":{"id":{"type":"string","example":"fed3ada8-7d9b-4634-a0fe-471afe0518b6","x-format":{"guid":true}},"rawKey":{"type":"string","example":"pl_a89026d28a0c45cf9e11b4c3637f3912"},"maskedKey":{"type":"string","description":"The masked key value.","example":"...6a1e"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","rawKey","maskedKey","created_at"]},"Model227":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"RunningAgentInfo":{"type":"object","properties":{"id":{"type":"string"},"lastSeenAt":{"type":"string"}},"required":["id","lastSeenAt"]},"agents":{"type":"array","items":{"$ref":"#/components/schemas/RunningAgentInfo"}},"RunningAgent":{"type":"object","properties":{"version":{"type":"string"},"count":{"type":"number"},"agents":{"$ref":"#/components/schemas/agents"}},"required":["version","count","agents"]},"runningAgents":{"type":"array","description":"A list of agent versions and their counts currently connected to this private location.","items":{"$ref":"#/components/schemas/RunningAgent"}},"privateLocationsSchema":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model227"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true},"lastSeen":{"type":"string","format":"date","nullable":true},"agentCount":{"type":"number","nullable":true},"minAgentVersion":{"type":"string","description":"The lowest agent version currently connected to this private location.","nullable":true},"runningAgents":{"$ref":"#/components/schemas/runningAgents"}},"required":["id","name","slugName","created_at"]},"privateLocationsListSchema":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationsSchema"}},"privateLocationCreate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location","pattern":"^((?!((us(-gov)?|ap|ca|cn|eu|sa|af|me)-(central|(north|south)?(east|west)?)-\\d+))[a-zA-Z0-9-]{1,30})$"},"icon":{"type":"string","example":"location","default":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name","slugName"]},"Model228":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"commonPrivateLocationSchemaResponse":{"type":"object","properties":{"id":{"type":"string","example":"0baf2a80-7266-44af-b56c-2af7086782ee","x-format":{"guid":true}},"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"slugName":{"type":"string","description":"Valid slug name.","example":"new-private-location"},"icon":{"type":"string","description":"The private location icon.","example":"location"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"keys":{"$ref":"#/components/schemas/Model228"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["id","name","slugName","created_at"]},"privateLocationUpdate":{"type":"object","properties":{"name":{"type":"string","description":"The name assigned to the private location.","example":"New Private Location"},"icon":{"type":"string","example":"location"},"proxyUrl":{"type":"string","description":"A proxy for outgoing API check HTTP calls from your private location.","example":"https://user:password@164.92.149.127:3128","nullable":true}},"required":["name"]},"timestamps":{"type":"array","items":{"type":"string","format":"date-time"}},"queueSize":{"type":"array","items":{"type":"number"}},"oldestScheduledCheckRun":{"type":"array","items":{"type":"number"}},"privateLocationsMetricsHistoryResponseSchema":{"type":"object","properties":{"timestamps":{"$ref":"#/components/schemas/timestamps"},"queueSize":{"$ref":"#/components/schemas/queueSize"},"oldestScheduledCheckRun":{"$ref":"#/components/schemas/oldestScheduledCheckRun"}}},"ReportingTagList":{"type":"array","description":"Check tags.","example":["production"],"items":{"type":"string"}},"ReportingAggregate":{"type":"object","properties":{"successRatio":{"type":"number","description":"Success ratio of the check over selected date range. Percentage is in decimal form.","example":50,"minimum":0},"avg":{"type":"number","description":"Average response time of the check over selected date range in milliseconds.","example":100,"minimum":0},"p95":{"type":"number","description":"P95 response time of the check over selected date range in milliseconds.","example":200,"minimum":0},"p99":{"type":"number","description":"P99 response time of the check over selected date range in milliseconds.","example":100,"minimum":0}},"required":["successRatio","avg","p95","p99"]},"Reporting":{"type":"object","properties":{"name":{"type":"string","description":"Check name.","example":"API Check"},"checkId":{"type":"string","description":"Check ID.","example":"d2881e09-411b-4c8d-84b8-fe05fbca80b6"},"checkType":{"type":"string","description":"Check type.","example":"API"},"deactivated":{"type":"boolean","description":"Check deactivated.","default":false},"tags":{"$ref":"#/components/schemas/ReportingTagList"},"aggregate":{"$ref":"#/components/schemas/ReportingAggregate"}},"required":["name","checkId","checkType","deactivated","tags"]},"ReportingList":{"type":"array","items":{"$ref":"#/components/schemas/Reporting"}},"PostRcaErrorGroup":{"type":"object","nullable":true,"properties":{"userContext":{"type":"string","description":"Optional user defined context to provide extra details useful for the user impact and root cause analysis.","default":"","nullable":true,"maxLength":256}}},"Model229":{"type":"string","enum":["PENDING"]},"Model230":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model229"}},"required":["id","status"]},"Model231":{"type":"string","enum":["PENDING"]},"PostRcaTestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model231"}},"required":["id","status"]},"Model232":{"type":"object","properties":{"name":{"type":"string","description":"Identifier of the artifact, e.g. \"HTTP_REQUEST\" or \"TIMING_PHASES\""},"type":{"type":"string","description":"Category of the artifact, e.g. \"REQUEST\", \"TIMINGS\", or \"TRACE\""}},"required":["name","type"]},"artifacts":{"type":"array","description":"Artifacts referenced by this piece of evidence","items":{"$ref":"#/components/schemas/Model232"}},"Model233":{"type":"object","properties":{"artifacts":{"$ref":"#/components/schemas/artifacts"},"description":{"type":"string","description":"Explanation of how this evidence support the root cause analysis"}},"required":["artifacts","description"]},"evidence":{"type":"array","description":"Supporting evidence derived from check result artifacts","nullable":true,"items":{"$ref":"#/components/schemas/Model233"}},"Model234":{"type":"object","properties":{"url":{"type":"string","description":"URL of the reference resource","x-format":{"uri":true}},"title":{"type":"string","description":"Display title for the link"}},"required":["url","title"]},"referenceLinks":{"type":"array","description":"Links to relevant documentation or external resources","nullable":true,"items":{"$ref":"#/components/schemas/Model234"}},"analysis":{"type":"object","properties":{"classification":{"type":"string","description":"High-level error categorization. e.g. \"INFRA ERROR\""},"userImpact":{"type":"string","description":"Human-readable summary of how this failure affects end users"},"rootCause":{"type":"string","description":"Explanation of the underlying cause of the failure"},"codeFix":{"type":"string","description":"Suggested code or configuration change to resolve the issue","nullable":true},"evidence":{"$ref":"#/components/schemas/evidence"},"referenceLinks":{"$ref":"#/components/schemas/referenceLinks"}},"required":["classification","userImpact","rootCause"]},"Model235":{"type":"string","enum":["COMPLETED"]},"GetRca":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"checkType":{"type":"string","description":"Type of check that triggered this analysis, e.g. \"API\" or \"BROWSER\""},"provider":{"type":"string","description":"AI provider used for the analysis"},"model":{"type":"string","description":"AI model used for the analysis"},"checkId":{"type":"string","nullable":true,"x-format":{"guid":true}},"errorGroupId":{"type":"string","nullable":true,"x-format":{"guid":true}},"durationMs":{"type":"number","description":"Time taken to generate the analysis in milliseconds"},"analysis":{"$ref":"#/components/schemas/analysis"},"status":{"$ref":"#/components/schemas/Model235"},"created_at":{"type":"string","format":"date"}},"required":["id","checkType","provider","model","durationMs","status"]},"Model236":{"type":"string","enum":["PENDING"]},"GetRcaPending":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"status":{"$ref":"#/components/schemas/Model236"}},"required":["id","status"]},"stage":{"type":"string","description":"Current life stage of a runtime.","example":"STABLE","enum":["ALPHA","BETA","CURRENT","DEPRECATED","REMOVED","STABLE"]},"DependenciesList":{"type":"object","description":"An object with all dependency package names and versions as in a standard package.json.","example":{"@playwright/test":"1.58.2","@axe-core/playwright":"4.11.1","@azure/identity":"4.13.0","@azure/keyvault-secrets":"4.10.0","@checkly/playwright-helpers":"1.0.4","@clerk/testing":"1.14.2","@faker-js/faker":"10.3.0","@google-cloud/local-auth":"3.0.1","@kubernetes/client-node":"1.4.0","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.212.0","@opentelemetry/sdk-metrics":"2.5.1","@opentelemetry/sdk-trace-base":"2.5.1","@t3-oss/env-nextjs":"0.7.3","@xmldom/xmldom":"0.9.8","aws4":"1.13.2","axios":"1.13.5","axios-cookiejar-support":"5.0.5","crypto-js":"4.2.0","csv-parse":"6.1.0","date-fns":"4.1.0","date-fns-tz":"3.2.0","dotenv":"17.3.1","ethers":"6.16.0","expect":"30.2.0","form-data":"4.0.5","gaxios":"7.1.3","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"10.6.1","googleapis":"171.4.0","graphql":"16.13.0","graphql-tag":"2.12.6","http":"24.13.1","https":"24.13.1","imapflow":"1.2.10","jose":"6.1.3","jsonwebtoken":"9.0.3","lodash":"4.17.23","long":"5.3.2","mailosaur":"11.0.2","moment":"2.30.1","mysql":"2.18.1","mysql2":"3.18.2","nice-grpc":"2.1.14","nice-grpc-client-middleware-deadline":"2.0.17","nice-grpc-client-middleware-devtools":"1.0.9","nice-grpc-client-middleware-retry":"3.1.13","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.12","nice-grpc-opentelemetry":"0.1.20","nice-grpc-prometheus":"0.2.9","nice-grpc-server-health":"2.0.17","nice-grpc-server-middleware-terminator":"2.0.16","nice-grpc-server-reflection":"3.0.3","nice-grpc-web":"3.3.9","node-pop3":"0.11.0","otpauth":"9.5.0","pdf-parse":"1.1.1","pdf2json":"4.0.2","playwright":"1.58.2","prisma":"7.4.1","protobufjs":"8.0.0","tedious":"19.2.1","tough-cookie":"6.0.0","twilio":"5.12.2","uuid":"11.1.0","winston":"3.19.0","ws":"8.19.0","xml-crypto":"6.1.2","xml-encryption":"3.1.0","zod":"3.24.3"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2026.04"},"multiStepSupport":{"type":"boolean","description":"Does this runtime supports multi step checks"},"nodeJsVersion":{"type":"string","description":"The full Node.js version available in this runtime.","example":"v18.20.3"},"stage":{"$ref":"#/components/schemas/stage"},"runtimeEndOfLife":{"type":"string","description":"Date which a runtime will be removed from our platform.","example":"12/31/2022"},"description":{"type":"string","description":"A short, human readable description of the main updates in this runtime.","example":"Main updates are Playwright 1.58.2"},"dependencies":{"$ref":"#/components/schemas/DependenciesList"}},"required":["name","multiStepSupport","nodeJsVersion","dependencies"]},"RuntimeList":{"type":"array","items":{"$ref":"#/components/schemas/Runtime"}},"Snippet":{"type":"object","properties":{"id":{"type":"number","example":1},"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"},"created_at":{"type":"string","format":"date-time"},"updated_at":{"type":"string","format":"date-time","nullable":true}}},"SnippetList":{"type":"array","items":{"$ref":"#/components/schemas/Snippet"}},"SnippetCreate":{"type":"object","properties":{"name":{"type":"string","description":"The snippet name.","example":"Snippet"},"script":{"type":"string","description":"Your Node.js code that interacts with the API check lifecycle, or functions as a partial for browser checks.","example":"request.url = request.url + '/extra'"}},"required":["name","script"]},"StatusPageThemeColors":{"type":"object","properties":{"bodyBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"headerFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"titleFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"bodyFontColorMuted":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"navigationFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"linkFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"cardBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"borderColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonBackgroundColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"},"primaryButtonFontColor":{"type":"string","pattern":"^#([0-9A-F]{3}|[0-9A-F]{6})$"}},"required":["bodyBackgroundColor","headerBackgroundColor","headerFontColor","titleFontColor","bodyFontColor","bodyFontColorMuted","navigationFontColor","linkFontColor","cardBackgroundColor","borderColor","primaryButtonBackgroundColor","primaryButtonFontColor"]},"StatusPageV2ThemeColors":{"type":"object","nullable":true,"properties":{"light":{"$ref":"#/components/schemas/StatusPageThemeColors"},"dark":{"$ref":"#/components/schemas/StatusPageThemeColors"}},"required":["light","dark"]},"defaultTheme":{"type":"string","default":"AUTO","enum":["LIGHT","DARK","AUTO"]},"StatusPageV2Service":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId","created_at"]},"StatusPageV2CardServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageV2Card":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServices"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","name","created_at"]},"StatusPageV2Cards":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Card"}},"IncidentSeverity":{"type":"string","enum":["CRITICAL","MAJOR","MEDIUM","MINOR"]},"IncidentServices":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"StatusPageIncidentStatus":{"type":"string","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED"]},"StatusPageV2IncidentUpdateWithId":{"type":"object","properties":{"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-21T03:11:54.098Z"},"notifySubscribers":{"type":"boolean","default":false},"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"}},"required":["description","id","created_at"]},"IncidentUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdateWithId"}},"StatusPageV2IncidentServices":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","lastUpdateStatus","created_at"]},"StatusPageV2Incidents":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentServices"}},"Model237":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"maskedKey":{"type":"string"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["id","maskedKey","created_at"]},"Model238":{"type":"array","items":{"$ref":"#/components/schemas/Model237"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true},"incidents":{"$ref":"#/components/schemas/StatusPageV2Incidents"},"isPrivate":{"type":"boolean","default":false},"keys":{"$ref":"#/components/schemas/Model238"}},"required":["name","url","id","accountId","created_at"]},"StatusPagesV2Entries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2"}},"StatusPagesV2PaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/StatusPagesV2Entries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"StatusPageV2CardServiceRef":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}}}},"StatusPageV2CardServiceRefs":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardServiceRef"}},"StatusPageV2CardUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"statusPageId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"services":{"$ref":"#/components/schemas/StatusPageV2CardServiceRefs"}},"required":["name"]},"StatusPageV2CardUpdates":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2CardUpdate"}},"StatusPageV2PublicApiUpdate":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"description":{"type":"string","nullable":true,"maxLength":500},"url":{"type":"string","x-convert":{"case":"lower"}},"customDomain":{"type":"string","description":"A custom user domain, e.g. \"status.example.com\". See the docs on updating your DNS and SSL usage.","nullable":true,"x-convert":{"case":"lower"}},"themeColors":{"$ref":"#/components/schemas/StatusPageV2ThemeColors"},"logo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"favicon":{"type":"string","nullable":true,"x-format":{"uri":{"scheme":["http","https"]}}},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"},"isPrivate":{"type":"boolean","default":false}},"required":["name","url","id"]},"StatusPageV2Incident":{"type":"object","properties":{"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"id":{"type":"string","x-format":{"guid":true}},"services":{"$ref":"#/components/schemas/IncidentServices"},"incidentUpdates":{"$ref":"#/components/schemas/IncidentUpdates"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"duration":{"type":"integer","nullable":true},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"}},"required":["name","severity","id","services","incidentUpdates","lastUpdateStatus","created_at"]},"IncidentsPaginatedEntries":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Incident"}},"IncidentsPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/IncidentsPaginatedEntries"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"IncidentService":{"type":"object","properties":{"name":{"type":"string"},"id":{"type":"string","x-format":{"guid":true}},"accountId":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date","nullable":true}},"required":["name","id","accountId"]},"IncidentCommonServices":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/IncidentService"}},"StatusPageV2IncidentUpdate":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"description":{"type":"string"},"status":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"publicIncidentUpdateDate":{"type":"string","format":"date-time","default":"2026-05-21T03:11:54.137Z"},"created_at":{"type":"string","format":"date"},"notifySubscribers":{"type":"boolean","default":false}},"required":["description"]},"CreateIncidentUpdates":{"type":"array","x-constraint":{"length":1},"items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"CreateStatusPageV2Incident":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true},"incidentUpdates":{"$ref":"#/components/schemas/CreateIncidentUpdates"}},"required":["name","severity","services","incidentUpdates"]},"StatusPageV2IncidentCommon":{"type":"object","properties":{"id":{"type":"string","x-format":{"guid":true}},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date"},"lastUpdateStatus":{"$ref":"#/components/schemas/StatusPageIncidentStatus"},"name":{"type":"string","maxLength":255},"severity":{"$ref":"#/components/schemas/IncidentSeverity"},"services":{"$ref":"#/components/schemas/IncidentCommonServices"},"duration":{"type":"integer","nullable":true}},"required":["name","severity","services"]},"Model239":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2IncidentUpdate"}},"ServiceList":{"type":"array","items":{"$ref":"#/components/schemas/StatusPageV2Service"}},"ServicesPaginatedResponse":{"type":"object","properties":{"length":{"type":"integer"},"entries":{"$ref":"#/components/schemas/ServiceList"},"nextId":{"type":"string","nullable":true}},"required":["length","entries"]},"CreateOrUpdateService":{"type":"object","properties":{"name":{"type":"string"}},"required":["name"]},"Model240":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model241":{"type":"string","description":"The status of the subscription.","enum":["PENDING","VERIFIED"]},"Subscription":{"type":"object","properties":{"id":{"type":"string","description":"The ID of the subscription."},"type":{"$ref":"#/components/schemas/Model240"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model241"},"created_at":{"type":"string","format":"date","description":"The date the subscription was created."},"updated_at":{"type":"string","format":"date","description":"The date the subscription was last updated."}},"required":["id","type","address","status","created_at","updated_at"]},"SubscriptionsList":{"type":"array","description":"The list of subscriptions for the status page.","items":{"$ref":"#/components/schemas/Subscription"}},"Model242":{"type":"string","description":"The type of subscription type, i.e. EMAIL.","example":"EMAIL","enum":["EMAIL"]},"Model243":{"type":"object","properties":{"type":{"$ref":"#/components/schemas/Model242"},"config":{"type":"string","description":"The configuration details for the status page subscription. These can be very different based on the type of the subscriptions."}},"required":["type","config"]},"subscriptions":{"type":"array","description":"The list of subscriptions to create (max 100).","minItems":1,"maxItems":100,"items":{"$ref":"#/components/schemas/Model243"}},"BulkCreateSubscriptionsPayload":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/subscriptions"}},"required":["subscriptions"]},"Model244":{"type":"string","description":"The status of the created subscriptions.","enum":["PENDING","VERIFIED"]},"BulkCreateSubscriptionsResponse":{"type":"object","properties":{"created":{"type":"number","description":"The number of subscriptions successfully created."},"skipped":{"type":"number","description":"The number of subscriptions skipped (already exist)."},"status":{"$ref":"#/components/schemas/Model244"}},"required":["created","skipped","status"]},"environments":{"type":"array","description":"The environments in which this error has been observed.","nullable":true,"items":{"type":"string"}},"suitePath":{"type":"array","items":{"type":"string"}},"Model245":{"type":"object","properties":{"projectName":{"type":"string"},"testFile":{"type":"string"},"testTitle":{"type":"string"},"suitePath":{"$ref":"#/components/schemas/suitePath"}},"required":["projectName","testFile","testTitle","suitePath"]},"pwtMetadata":{"type":"array","description":"Playwright test metadata: project, file, title, and suite path for each occurrence.","nullable":true,"items":{"$ref":"#/components/schemas/Model245"}},"Model246":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model246"}},"TestSessionErrorGroup":{"type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string","nullable":true},"environments":{"$ref":"#/components/schemas/environments"},"errorHash":{"type":"string","description":"The hash of the cleaned error message for quicker deduplication."},"rawErrorMessage":{"type":"string","description":"The raw error message as recorded in a test session result.","nullable":true},"cleanedErrorMessage":{"type":"string","description":"The cleaned and sanitized error message used for hashing and grouping."},"firstSeen":{"type":"string","format":"date"},"lastSeen":{"type":"string","format":"date"},"archivedUntilNextEvent":{"type":"boolean"},"pwtMetadata":{"$ref":"#/components/schemas/pwtMetadata"},"rootCauseAnalyses":{"$ref":"#/components/schemas/rootCauseAnalyses"}},"required":["id","environments","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent","pwtMetadata"]},"TestSessionErrorGroupPatch":{"type":"object","properties":{"archiveForEver":{"type":"boolean"},"archivedUntilNextEvent":{"type":"boolean"}}},"CheckGroupTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"groupId":{"type":"number","example":1}},"required":["id","token","created_at","groupId"]},"CheckTrigger":{"type":"object","properties":{"id":{"type":"number","example":1},"token":{"type":"string","example":"h7QMmh8c0hYw"},"created_at":{"type":"string","format":"date"},"called_at":{"type":"string","format":"date","nullable":true},"updated_at":{"type":"string","format":"date","nullable":true},"checkId":{"type":"string","example":"a13a7875-ec45-4780-b39f-675ec288cfe1"}},"required":["id","token","created_at","checkId"]},"Model247":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model248":{"type":"string","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"Model249":{"type":"array","description":"An array of one or more data center locations where to run the checks.","example":["us-east-1","eu-central-1"],"items":{"$ref":"#/components/schemas/Model248"}},"Model250":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2026.04","2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model251":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model40"}},"Model252":{"type":"array","description":"An array of one or more private locations where to run the checks.","example":["data-center-eu"],"nullable":true,"items":{"type":"string"}},"AlertSettingsEscalationType":{"type":"string","description":"Determines what type of escalation to use","default":"RUN_BASED","enum":["RUN_BASED","TIME_BASED"]},"Model253":{"type":"object","properties":{"failedRunThreshold":{"type":"number","description":"After how many failed consecutive check runs an alert notification should be send","default":1,"enum":[1,2,3,4,5]}}},"Model254":{"type":"object","properties":{"minutesFailingThreshold":{"type":"number","description":"After how many minutes after a check starts failing an alert should be send","default":5,"enum":[5,10,15,30]}}},"Model255":{"type":"object","properties":{"amount":{"type":"number","description":"How many reminders to send out after the initial alert notification","default":0,"enum":[0,1,2,3,4,5,100000]},"interval":{"type":"number","description":"At what interval the reminders should be send","default":5,"enum":[1,2,3,4,5,10,15,30]}}},"AlertSettingsParallelRunFailureThreshold":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Determines if parallel run threshold is enabled","default":false},"percentage":{"type":"number","description":"The percentage of parallel runs that should fail before an alert is triggered","default":10,"enum":[10,20,30,40,50,60,70,80,90,100]}}},"InternalAlertSettingsCreate":{"type":"object","default":null,"nullable":true,"properties":{"escalationType":{"$ref":"#/components/schemas/AlertSettingsEscalationType"},"runBasedEscalation":{"$ref":"#/components/schemas/Model253"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model254"},"reminders":{"$ref":"#/components/schemas/Model255"},"parallelRunFailureThreshold":{"$ref":"#/components/schemas/AlertSettingsParallelRunFailureThreshold"}}},"CheckGroupCreateOrUpdateV2":{"type":"object","properties":{"name":{"type":"string","description":"The name of the check group.","example":"Check group"},"activated":{"type":"boolean","description":"Determines if the checks in the group are running or not.","default":true},"muted":{"type":"boolean","description":"Determines if any notifications will be send out when a check in this group fails and/or recovers.","default":false},"tags":{"$ref":"#/components/schemas/CheckGroupTagList"},"locations":{"$ref":"#/components/schemas/Model249"},"concurrency":{"type":"number","description":"Determines how many checks are invoked concurrently when triggering a check group from CI/CD or through the API.","default":3,"minimum":1,"x-constraint":{"sign":"positive"}},"apiCheckDefaults":{"$ref":"#/components/schemas/CheckGroupCreateAPICheckDefaults"},"browserCheckDefaults":{"type":"string"},"runtimeId":{"$ref":"#/components/schemas/Model250"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model251"},"setupSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"tearDownSnippetId":{"type":"number","description":"An ID reference to a snippet to use in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"localSetupScript":{"type":"string","description":"A valid piece of Node.js code to run in the setup phase of an API check in this group.","example":null,"default":null,"nullable":true},"localTearDownScript":{"type":"string","description":"A valid piece of Node.js code to run in the teardown phase of an API check in this group.","example":null,"default":null,"nullable":true},"privateLocations":{"$ref":"#/components/schemas/Model252"},"runParallel":{"type":"boolean","description":"When true, the checks in the group will run in parallel in all selected locations.","default":null,"nullable":true},"alertSettings":{"$ref":"#/components/schemas/InternalAlertSettingsCreate"},"retryStrategy":{"description":"Either a retry strategy object or the literal string \"FALLBACK\".","default":"FALLBACK","anyOf":[{"$ref":"#/components/schemas/RetryStrategy"},{"$ref":"#/components/schemas/FallbackRetryStrategy"}]},"useGlobalAlertSettings":{"type":"boolean","description":"When true, the checks in the group will use the alert settings that are configured on the account","default":null,"nullable":true},"doubleCheck":{"type":"boolean","default":false}},"required":["name"]},"entries":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"CheckResultListV2":{"type":"object","properties":{"length":{"type":"number"},"entries":{"$ref":"#/components/schemas/entries"},"nextId":{"type":"string","nullable":true}},"required":["length"]}},"parameters":{}},"tags":[],"paths":{"/v1/accounts":{"get":{"summary":"Fetch user accounts","operationId":"getV1Accounts","description":"List account details based on supplied API key.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me":{"get":{"summary":"Fetch current account details","operationId":"getV1AccountsMe","description":"Get details from the current account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/entitlements":{"get":{"summary":"Fetch current account entitlements","operationId":"getV1AccountsMeEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/me/members":{"get":{"summary":"List current account members and pending invites","operationId":"getV1AccountsMeMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/accounts/{accountId}":{"get":{"summary":"Fetch a given account details","operationId":"getV1AccountsAccountid","description":"Get details from a specific account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Account"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/entitlements":{"get":{"summary":"Fetch account entitlements","operationId":"getV1AccountsAccountidEntitlements","description":"Fetch the entitlements for the account, including feature access and limits based on the current plan.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Entitlements"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/accounts/{accountId}/members":{"get":{"summary":"List account members and pending invites","operationId":"getV1AccountsAccountidMembers","tags":["Accounts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AccountMembersList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid"},"required":true,"name":"accountId","in":"path"},{"schema":{"type":"string","description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored."},"required":false,"description":"Case-insensitive partial match against member name, member email, and invite email. Empty searches are ignored.","name":"search","in":"query"},{"schema":{"type":"string","enum":["member","invite"],"description":"Filter by account member list item type."},"required":false,"description":"Filter by account member list item type.","name":"type","in":"query"},{"schema":{"type":"string","enum":["OWNER","ADMIN","READ_WRITE","READ_RUN","READ_ONLY"],"description":"Filter by account role. Valid filters may produce no results for invites."},"required":false,"description":"Filter by account role. Valid filters may produce no results for invites.","name":"role","in":"query"},{"schema":{"type":"string","enum":["ACTIVE","PENDING","EXPIRED"],"description":"Filter by member or invite status. Valid filters may produce no results for some item types."},"required":false,"description":"Filter by member or invite status. Valid filters may produce no results for some item types.","name":"status","in":"query"},{"schema":{"type":"integer","minimum":1,"maximum":100,"description":"Page length. Omitted returns all matching members and invites."},"required":false,"description":"Page length. Omitted returns all matching members and invites.","name":"limit","in":"query"},{"schema":{"type":"string","minLength":1,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params."},"required":false,"description":"Opaque cursor returned from a previous limited request. Only accepted with limit and the same query params.","name":"nextId","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v1/alert-channels":{"get":{"summary":"List all alert channels","operationId":"getV1Alertchannels","description":"Lists all configured alert channels and their subscribed checks.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create an alert channel","operationId":"postV1Alertchannels","description":"Creates a new alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}":{"delete":{"summary":"Delete an alert channel","operationId":"deleteV1AlertchannelsId","description":"Permanently removes an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an alert channel","operationId":"getV1AlertchannelsId","description":"Show details of a specific alert channel.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an alert channel","operationId":"putV1AlertchannelsId","description":"Update an alert channel","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannel"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-channels/{id}/subscriptions":{"put":{"summary":"Update the subscriptions of an alert channel","operationId":"putV1AlertchannelsIdSubscriptions","description":"Update the subscriptions of an alert channel. Use this to add a check to an alert channel so failure and recovery alerts are send out for that check. Note: when passing the subscription object, you can only specify a \"checkId\" or a \"groupId, not both.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Alert channels"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChannelSubscriptionCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertChanelSubscription"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/alert-notifications":{"get":{"summary":"Lists all alert notifications","operationId":"getV1Alertnotifications","description":"Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 24-hour timeframe. If the `from` and `to` params are set, they must be at most 24 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 24 hours earlier. If only the `to` param is set we will set `from` to be 24 hours earlier. If only the `from` param is set we will consider the `to` param to be 24 hours later. @@ -26,7 +26,7 @@ Currently only `quickRange` is supported for time filtering. Arbitrary `from`/`t **Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["total","dns","connection","data","availability","retries","total_avg","total_max","total_median","total_min","total_p50","total_p90","total_p95","total_p99","total_stddev","total_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","connection_avg","connection_max","connection_median","connection_min","connection_p50","connection_p90","connection_p95","connection_p99","connection_stddev","connection_sum","data_avg","data_max","data_median","data_min","data_p50","data_p90","data_p95","data_p99","data_stddev","data_sum"]}},"description":"Available metrics for TCP Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model35"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/analytics/url-monitors/{id}":{"get":{"summary":"URL Monitors","operationId":"getV1AnalyticsUrlmonitorsId","description":"Fetch detailed availability metrics and aggregated or non-aggregated API Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the DNS phases of your API check together with the availability percentage for any time range. -**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/check-sessions/{checkSessionId}/cancel":{"post":{"summary":"Cancel a check session","operationId":"postV1ChecksessionsChecksessionidCancel","description":"Cancels in-progress Playwright Check Suite runs within the specified check session. Use the optional `sequenceId` field in the request body to cancel only specific parallel runs within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. Returns `404 Not Found` if the check session does not exist.","tags":["Check sessions"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV1CancelRequest"}}}}}},"/v1/test-sessions/{testSessionId}/cancel":{"post":{"summary":"Cancel a test session","operationId":"postV1TestsessionsTestsessionidCancel","description":"Cancels in-progress Playwright runs within the specified test session. Use the optional `sequenceId` field in the request body to cancel only specific results within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. Returns `404 Not Found` if the test session does not exist.","tags":["Test sessions"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Test session ID."},"required":true,"description":"Test session ID.","name":"testSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TestSessionsV1CancelRequest"}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. +**Rate-limiting is applied to this endpoint, you can send 30 requests / 60 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom start time of reporting window in unix timestamp format. Setting a custom \"from\" timestamp overrides the use of any \"quickRange\"."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},"description":"Custom end time of reporting window in unix timestamp format. Setting a custom \"to\" timestamp overrides the use of any \"quickRange\"."},{"name":"quickRange","in":"query","schema":{"type":"string","description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp.","default":"last24Hours","enum":["last24Hours","last7Days","last30Days","thisWeek","thisMonth","lastWeek","lastMonth"]},"description":"Preset reporting windows are used for quickly generating report on commonly used windows. Can be overridden by using a custom \"to\" and \"from\" timestamp."},{"name":"aggregationInterval","in":"query","schema":{"type":"number","description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440.","example":1440,"minimum":1,"maximum":43200},"description":"The time interval to use for aggregating metrics in minutes. For example, five minutes is 5, 24 hours is 1440."},{"name":"filterByStatus","in":"query","schema":{"type":"array","description":"Filter based on whether a check result was either failing or passing","example":["failure"],"x-constraint":{"single":true},"items":{"type":"string","enum":["success","failure"]}},"description":"Filter based on whether a check result was either failing or passing","style":"form","explode":true},{"name":"groupBy","in":"query","schema":{"type":"string","description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer.","enum":["runLocation","statusCode"]},"description":"Determines how the series data is grouped. Note that grouped queries are a bit more expensive and might take longer."},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","wait","dns","tcp","firstByte","download","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","wait_avg","wait_max","wait_median","wait_min","wait_p50","wait_p90","wait_p95","wait_p99","wait_stddev","wait_sum","dns_avg","dns_max","dns_median","dns_min","dns_p50","dns_p90","dns_p95","dns_p99","dns_stddev","dns_sum","tcp_avg","tcp_max","tcp_median","tcp_min","tcp_p50","tcp_p90","tcp_p95","tcp_p99","tcp_stddev","tcp_sum","firstByte_avg","firstByte_max","firstByte_median","firstByte_min","firstByte_p50","firstByte_p90","firstByte_p95","firstByte_p99","firstByte_stddev","firstByte_sum","download_avg","download_max","download_median","download_min","download_p50","download_p90","download_p95","download_p99","download_stddev","download_sum"]}},"description":"Available metrics for API Checks. You can pass multiple metrics as a comma separated string.","style":"form","explode":true,"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Analytics"],"responses":{"200":{"description":"Success","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model37"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/badges/checks/{checkId}":{"get":{"operationId":"getV1BadgesChecksCheckid","description":"Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/badges/groups/{groupId}":{"get":{"operationId":"getV1BadgesGroupsGroupid","description":"Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general)","parameters":[{"name":"groupId","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true},{"name":"style","in":"query","schema":{"type":"string","default":"flat","enum":["flat","plastic","flat-square","for-the-badge","social"]}},{"name":"theme","in":"query","schema":{"type":"string","default":"default","enum":["light","dark","default"]}},{"name":"responseTime","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Badges"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"type":"string","pattern":"(]*)"}}}}}}},"/v1/cancel":{"post":{"summary":"Cancel a check run, check session, test run, or test session","operationId":"postV1Cancel","description":"Cancels in-progress Playwright Check Suite runs. The request body must reference exactly one of `checkSessionId` or `testSessionId`. A `checkSessionId` is obtained from `POST /v2/check-sessions/trigger`. Use the optional `sequenceId` field to cancel only specific parallel runs within the session; omit it to cancel everything still running.\n\nReturns `204 No Content` once the cancellation requests have been dispatched. The response does not confirm whether the session was found or eligible — use `GET /v2/check-sessions/{checkSessionId}` to verify the resulting state.","tags":["cancel"],"responses":{"204":{"description":"Cancellation accepted."},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CancelRequest"}}}}}},"/v1/check-alerts":{"get":{"summary":"List all alerts for your account","operationId":"getV1Checkalerts","description":"Lists all alerts that have been sent for your account. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most 6 hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be 6 hours earlier. If only the `to` param is set we will set `from` to be 6 hours earlier. If only the `from` param is set we will consider the `to` param to be 6 hours later.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."}],"tags":["Check alerts"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAlertList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-alerts/{checkId}":{"get":{"summary":"List alerts for a specific check","operationId":"getV1CheckalertsCheckid","description":"Lists all the alerts for a specific check. @@ -37,7 +37,7 @@ You can filter by check type and result type to narrow down the list. Use the `t This endpoint will return data within a 6-hour timeframe. If the `from` and `to` params are set, they must be at most six hours apart. If none are set, we will consider the `to` param to be now and the `from` param to be six hours earlier. If only the `to` param is set we will set `from` to be six hours earlier. On the contrary, if only the `from` param is set we will consider the `to` param to be six hours later. -**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-results/{checkId}/{checkResultId}":{"get":{"summary":"Retrieve a check result","operationId":"getV1CheckresultsCheckidCheckresultid","description":"Show details of a specific check result.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"checkResultId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV1ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v1/check-sessions/{checkSessionId}/completion` or `GET /v1/check-sessions/{checkSessionId}` endpoints to track progress if needed.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionRequestPayload"}}}},"responses":{"201":{"description":"Returns a check session for each check matching target conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Returned when there are no matching checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoMatchingChecksFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV1ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true}],"tags":["Check sessions"],"responses":{"200":{"description":"The current state of the check session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV1ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true},{"name":"maxWaitSeconds","in":"query","schema":{"type":"number","description":"The maximum time to wait for completion, in seconds.","example":30,"minimum":1,"maximum":30},"description":"The maximum time to wait for completion, in seconds."}],"tags":["Check sessions"],"responses":{"200":{"description":"Returned when the check session has finished running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"408":{"description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionTryAgainResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-statuses":{"get":{"summary":"List all check statuses","operationId":"getV1Checkstatuses","description":"Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatusList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-statuses/{checkId}":{"get":{"summary":"Retrieve check status details","operationId":"getV1CheckstatusesCheckid","description":"Show the current status information for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatus"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks":{"get":{"summary":"List all checks","operationId":"getV1Checks","description":"Lists all current checks in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"apiCheckUrlFilterPattern","in":"query","schema":{"type":"string","description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks.","minLength":1},"description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks."},{"name":"tag","in":"query","schema":{"type":"array","description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","style":"form","explode":true},{"name":"checkType","in":"query","schema":{"type":"string","description":"Filters checks by type. Returns checks that match the specified type.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"Filters checks by type. Returns checks that match the specified type."},{"name":"search","in":"query","schema":{"type":"string","description":"Filters checks by name using a case-insensitive partial match."},"description":"Filters checks by name using a case-insensitive partial match."},{"name":"status","in":"query","schema":{"type":"string","description":"Filters checks by current status.","enum":["passing","failing","degraded"]},"description":"Filters checks by current status."},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a check","operationId":"postV1Checks","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `POST /checks/api` or `POST /checks/browser`.** Creates a new API or browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSettings`, the `alertSettings` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/checks/api":{"post":{"summary":"Create an API check","operationId":"postV1ChecksApi","description":"Creates a new API check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPICreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/api/{id}":{"put":{"summary":"Update an API check","operationId":"putV1ChecksApiId","description":"Updates an API check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPIUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser":{"post":{"summary":"Create a browser check","operationId":"postV1ChecksBrowser","description":"Creates a new browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser/{id}":{"put":{"summary":"Update a browser check","operationId":"putV1ChecksBrowserId","description":"Updates a browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns":{"post":{"summary":"Create an DNS monitor","operationId":"postV1ChecksDns","description":"Creates a new DNS monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDNSCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns/{id}":{"put":{"summary":"Update an DNS Monitor","operationId":"putV1ChecksDnsId","description":"Updates an DNS monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat":{"post":{"summary":"Create a heartbeat check","operationId":"postV1ChecksHeartbeat","description":"Creates a new Heartbeat check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat/{id}":{"put":{"summary":"Update a heartbeat check","operationId":"putV1ChecksHeartbeatId","description":"Updates a Heartbeat check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/availability":{"get":{"summary":"Get heartbeat availability","operationId":"getV1ChecksHeartbeatsCheckidAvailability","description":"Get heartbeat availability.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-19T15:50:39.669Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T15:50:39.669Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model131"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events":{"get":{"summary":"Get a list of events for a heartbeat","operationId":"getV1ChecksHeartbeatsCheckidEvents","description":"Get all events from a heartbeat.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-19T15:50:39.672Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T15:50:39.672Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model134"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events/{id}":{"get":{"summary":"Get a specific Heartbeat event","operationId":"getV1ChecksHeartbeatsCheckidEventsId","description":"Get a specific event by its id.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model135"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp":{"post":{"summary":"Create an ICMP monitor","operationId":"postV1ChecksIcmp","description":"Creates a new ICMP monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp/{id}":{"put":{"summary":"Update an ICMP Monitor","operationId":"putV1ChecksIcmpId","description":"Updates an ICMP monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep":{"post":{"summary":"Create a multi-step check","operationId":"postV1ChecksMultistep","description":"Creates a new Multi-Step check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep/{id}":{"put":{"summary":"Update a multi-step check","operationId":"putV1ChecksMultistepId","description":"Updates a Multi-Step check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp":{"post":{"summary":"Create a TCP check","operationId":"postV1ChecksTcp","description":"Creates a new TCP check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp/{id}":{"put":{"summary":"Update an TCP check","operationId":"putV1ChecksTcpId","description":"Updates an TCP check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url":{"post":{"summary":"Create a URL monitor","operationId":"postV1ChecksUrl","description":"Creates a new URL monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url/{id}":{"put":{"summary":"Update an URL Monitor","operationId":"putV1ChecksUrlId","description":"Updates an URL monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/{id}":{"delete":{"summary":"Delete a check","operationId":"deleteV1ChecksId","description":"Permanently removes a API or browser check and all its related status and results data.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Checks"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check","operationId":"getV1ChecksId","description":"Show details of a specific API or browser check","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeDependencies","in":"query","schema":{"type":"boolean","description":"Include check dependencies in the response"},"description":"Include check dependencies in the response"},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a check","operationId":"putV1ChecksId","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `PUT /checks/api/{id}` or `PUT /checks/browser/{id}`.** Updates a new API or browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/client-certificates":{"get":{"summary":"Lists all client certificates.","operationId":"getV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Creates a new client certificate.","operationId":"postV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/client-certificates/{id}":{"delete":{"summary":"Deletes a client certificate.","operationId":"deleteV1ClientcertificatesId","description":"Permanently removes a client certificate.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Shows one client certificate.","operationId":"getV1ClientcertificatesId","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards":{"get":{"summary":"List all dashboards","operationId":"getV1Dashboards","description":"Lists all current dashboards in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a dashboard","operationId":"postV1Dashboards","description":"Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards/{dashboardId}":{"delete":{"summary":"Delete a dashboard","operationId":"deleteV1DashboardsDashboardid","description":"Permanently removes a dashboard.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a dashboard","operationId":"getV1DashboardsDashboardid","description":"Show details of a specific dashboard. +**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},"description":"Select records up from this UNIX timestamp (>= date). Defaults to now - 6 hours."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},"description":"Optional. Select records up to this UNIX timestamp (< date). Defaults to 6 hours after \"from\"."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-results/{checkId}/{checkResultId}":{"get":{"summary":"Retrieve a check result","operationId":"getV1CheckresultsCheckidCheckresultid","description":"Show details of a specific check result.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"checkResultId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResult"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV1ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v1/check-sessions/{checkSessionId}/completion` or `GET /v1/check-sessions/{checkSessionId}` endpoints to track progress if needed.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionRequestPayload"}}}},"responses":{"201":{"description":"Returns a check session for each check matching target conditions.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TriggerCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Returned when there are no matching checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NoMatchingChecksFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV1ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true}],"tags":["Check sessions"],"responses":{"200":{"description":"The current state of the check session.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/FindOneCheckSessionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV1ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes or fails).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v1/check-sessions/{checkSessionId}` endpoint's response for a completed check session.","parameters":[{"name":"checkSessionId","in":"path","schema":{"type":"string","description":"The unique identifier of the check session.","x-format":{"guid":true}},"description":"The unique identifier of the check session.","required":true},{"name":"maxWaitSeconds","in":"query","schema":{"type":"number","description":"The maximum time to wait for completion, in seconds.","example":30,"minimum":1,"maximum":30},"description":"The maximum time to wait for completion, in seconds."}],"tags":["Check sessions"],"responses":{"200":{"description":"Returned when the check session has finished running.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"No such check session exists.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionNotFoundErrorResponse"}}}},"408":{"description":"The check session is still pending, but the server requests a quick break. You should call the endpoint again. Optionally, try to respect the `Retry-After` header.\n\nThis error code is one of the transient error codes supported by *curl*'s `--retry` option.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AwaitCheckSessionCompletionTryAgainResponse"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/check-statuses":{"get":{"summary":"List all check statuses","operationId":"getV1Checkstatuses","description":"Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatusList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/check-statuses/{checkId}":{"get":{"summary":"Retrieve check status details","operationId":"getV1CheckstatusesCheckid","description":"Show the current status information for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check status"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckStatus"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks":{"get":{"summary":"List all checks","operationId":"getV1Checks","description":"Lists all current checks in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"apiCheckUrlFilterPattern","in":"query","schema":{"type":"string","description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks.","minLength":1},"description":"Filters the results by a string contained in the URL of an API check, for instance a domain like \"www.myapp.com\". Only returns API checks."},{"name":"tag","in":"query","schema":{"type":"array","description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters checks by tags. Returns checks that have at least one of the specified tags.","style":"form","explode":true},{"name":"checkType","in":"query","schema":{"type":"string","description":"Filters checks by type. Returns checks that match the specified type.","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"Filters checks by type. Returns checks that match the specified type."},{"name":"search","in":"query","schema":{"type":"string","description":"Filters checks by name using a case-insensitive partial match."},"description":"Filters checks by name using a case-insensitive partial match."},{"name":"status","in":"query","schema":{"type":"string","description":"Filters checks by current status.","enum":["passing","failing","degraded"]},"description":"Filters checks by current status."},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a check","operationId":"postV1Checks","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `POST /checks/api` or `POST /checks/browser`.** Creates a new API or browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSettings`, the `alertSettings` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/checks/api":{"post":{"summary":"Create an API check","operationId":"postV1ChecksApi","description":"Creates a new API check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPICreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/api/{id}":{"put":{"summary":"Update an API check","operationId":"putV1ChecksApiId","description":"Updates an API check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPIUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckAPI"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser":{"post":{"summary":"Create a browser check","operationId":"postV1ChecksBrowser","description":"Creates a new browser check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/browser/{id}":{"put":{"summary":"Update a browser check","operationId":"putV1ChecksBrowserId","description":"Updates a browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowserUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckBrowser"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns":{"post":{"summary":"Create an DNS monitor","operationId":"postV1ChecksDns","description":"Creates a new DNS monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckDNSCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/dns/{id}":{"put":{"summary":"Update an DNS Monitor","operationId":"putV1ChecksDnsId","description":"Updates an DNS monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorDNS"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat":{"post":{"summary":"Create a heartbeat check","operationId":"postV1ChecksHeartbeat","description":"Creates a new Heartbeat check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeat/{id}":{"put":{"summary":"Update a heartbeat check","operationId":"putV1ChecksHeartbeatId","description":"Updates a Heartbeat check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Heartbeats"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeatUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckHeartbeat"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/availability":{"get":{"summary":"Get heartbeat availability","operationId":"getV1ChecksHeartbeatsCheckidAvailability","description":"Get heartbeat availability.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T03:11:53.427Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-21T03:11:53.427Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model131"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events":{"get":{"summary":"Get a list of events for a heartbeat","operationId":"getV1ChecksHeartbeatsCheckidEvents","description":"Get all events from a heartbeat.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"startTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-20T03:11:53.429Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-05-21T03:11:53.429Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model134"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/heartbeats/{checkId}/events/{id}":{"get":{"summary":"Get a specific Heartbeat event","operationId":"getV1ChecksHeartbeatsCheckidEventsId","description":"Get a specific event by its id.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model135"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp":{"post":{"summary":"Create an ICMP monitor","operationId":"postV1ChecksIcmp","description":"Creates a new ICMP monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/icmp/{id}":{"put":{"summary":"Update an ICMP Monitor","operationId":"putV1ChecksIcmpId","description":"Updates an ICMP monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/IcmpMonitorUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MonitorICMP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep":{"post":{"summary":"Create a multi-step check","operationId":"postV1ChecksMultistep","description":"Creates a new Multi-Step check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/multistep/{id}":{"put":{"summary":"Update a multi-step check","operationId":"putV1ChecksMultistepId","description":"Updates a Multi-Step check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStepUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckMultiStep"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp":{"post":{"summary":"Create a TCP check","operationId":"postV1ChecksTcp","description":"Creates a new TCP check. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/tcp/{id}":{"put":{"summary":"Update an TCP check","operationId":"putV1ChecksTcpId","description":"Updates an TCP check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCPUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckTCP"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url":{"post":{"summary":"Create a URL monitor","operationId":"postV1ChecksUrl","description":"Creates a new URL monitor. Will return a `402` when you are over the limit of your plan.\n When using the `globalAlertSetting`, the `alertSetting` can be `null`","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/url/{id}":{"put":{"summary":"Update an URL Monitor","operationId":"putV1ChecksUrlId","description":"Updates an URL monitor.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Monitors"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURLUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckURL"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/checks/{id}":{"delete":{"summary":"Delete a check","operationId":"deleteV1ChecksId","description":"Permanently removes a API or browser check and all its related status and results data.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Checks"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check","operationId":"getV1ChecksId","description":"Show details of a specific API or browser check","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeDependencies","in":"query","schema":{"type":"boolean","description":"Include check dependencies in the response"},"description":"Include check dependencies in the response"},{"name":"applyGroupSettings","in":"query","schema":{"type":"boolean","description":"Checks that belong to a group are returned with group settings applied.","default":false},"description":"Checks that belong to a group are returned with group settings applied."}],"tags":["Checks"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a check","operationId":"putV1ChecksId","description":"**[DEPRECATED] This endpoint will be removed soon. Instead use `PUT /checks/api/{id}` or `PUT /checks/browser/{id}`.** Updates a new API or browser check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"autoAssignAlerts","in":"query","schema":{"type":"boolean","description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created.","default":true},"description":"Determines whether a new check will automatically be added as a subscriber to all existing alert channels when it gets created."}],"tags":["Checks"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}},"deprecated":true}},"/v1/client-certificates":{"get":{"summary":"Lists all client certificates.","operationId":"getV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Creates a new client certificate.","operationId":"postV1Clientcertificates","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Client certificates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/client-certificates/{id}":{"delete":{"summary":"Deletes a client certificate.","operationId":"deleteV1ClientcertificatesId","description":"Permanently removes a client certificate.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Shows one client certificate.","operationId":"getV1ClientcertificatesId","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Client certificates"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ClientCertificateRetrieve"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards":{"get":{"summary":"List all dashboards","operationId":"getV1Dashboards","description":"Lists all current dashboards in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a dashboard","operationId":"postV1Dashboards","description":"Creates a new dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/DashboardCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/dashboards/{dashboardId}":{"delete":{"summary":"Delete a dashboard","operationId":"deleteV1DashboardsDashboardid","description":"Permanently removes a dashboard.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a dashboard","operationId":"getV1DashboardsDashboardid","description":"Show details of a specific dashboard. **Rate-limiting is applied to this endpoint, you can send 10 requests / 20 seconds at most.**","parameters":[{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true},{"name":"type","in":"query","schema":{"type":"string","enum":["customUrl","customDomain"]}}],"tags":["Dashboards"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a dashboard","operationId":"putV1DashboardsDashboardid","description":"Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"dashboardId","in":"path","schema":{"type":"string"},"required":true}],"tags":["Dashboards"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model214"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Dashboard"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups":{"get":{"summary":"List all error groups in your account.","operationId":"getV1Errorgroups","description":"List all error groups in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups/checks/{checkId}":{"get":{"summary":"List all error groups for a specific check.","operationId":"getV1ErrorgroupsChecksCheckid","description":"List all error groups for a specific check.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupsList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/error-groups/{id}":{"get":{"summary":"Retrieve one error group.","operationId":"getV1ErrorgroupsId","description":"Retrieve one error group.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Error Groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"patch":{"summary":"Update an error group. Mainly used for archiving error groups.","operationId":"patchV1ErrorgroupsId","description":"Update an error group. Mainly used for archiving error groups.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Error Groups"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroupPatch"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorGroup"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents":{"post":{"summary":"Create an incident","operationId":"postV1Incidents","description":"Creates a new incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model218"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model222"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{id}":{"delete":{"summary":"Delete an incident","operationId":"deleteV1IncidentsId","description":"Permanently removes an incident and all its updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incidents"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve an incident","operationId":"getV1IncidentsId","description":"Shows details of a specific incident. Uses the \"includeAllIncidentUpdates\" query parameter to obtain all updates.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"includeAllIncidentUpdates","in":"query","schema":{"type":"boolean","description":"You use it to include all the incident updates.","example":true,"default":false},"description":"You use it to include all the incident updates."}],"tags":["Incidents"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model222"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an incident","operationId":"putV1IncidentsId","description":"Updates an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"probe","in":"query","schema":{"type":"boolean"}}],"tags":["Incidents"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model223"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model224"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{incidentId}/updates":{"post":{"summary":"Create an incident update","operationId":"postV1IncidentsIncidentidUpdates","description":"Creates a new update for an incident.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model217"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/IncidentResults"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/incidents/{incidentId}/updates/{id}":{"delete":{"summary":"Delete an incident update","operationId":"deleteV1IncidentsIncidentidUpdatesId","description":"Permanently removes an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update an incident update","operationId":"putV1IncidentsIncidentidUpdatesId","description":"Modifies an incident update.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"incidentId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Incident Updates"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model225"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model220"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/locations":{"get":{"summary":"Lists all supported locations","operationId":"getV1Locations","description":"Lists all supported locationss.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Location"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LocationList"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/maintenance-windows":{"get":{"summary":"List all maintenance windows","operationId":"getV1Maintenancewindows","description":"Lists all maintenance windows in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results"},{"name":"page","in":"query","schema":{"type":"number","description":"Page number","default":1,"x-constraint":{"sign":"positive"}},"description":"Page number"},{"name":"startsAt","in":"query","schema":{"description":"Filter for items which startsAt field matches the constraint","anyOf":[{"type":"object","properties":{"gt":{"type":"string","format":"date"}},"required":["gt"]},{"type":"object","properties":{"gte":{"type":"string","format":"date"}},"required":["gte"]},{"type":"object","properties":{"lt":{"type":"string","format":"date"}},"required":["lt"]},{"type":"object","properties":{"lte":{"type":"string","format":"date"}},"required":["lte"]}]},"description":"Filter for items which startsAt field matches the constraint"},{"name":"endsAt","in":"query","schema":{"description":"Filter for items which endsAt field matches the constraint","anyOf":[{"type":"object","properties":{"gt":{"type":"string","format":"date"}},"required":["gt"]},{"type":"object","properties":{"gte":{"type":"string","format":"date"}},"required":["gte"]},{"type":"object","properties":{"lt":{"type":"string","format":"date"}},"required":["lt"]},{"type":"object","properties":{"lte":{"type":"string","format":"date"}},"required":["lte"]}]},"description":"Filter for items which endsAt field matches the constraint"}],"tags":["Maintenance windows"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowList"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a maintenance window","operationId":"postV1Maintenancewindows","description":"Creates a new maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Maintenance windows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/maintenance-windows/{id}":{"delete":{"summary":"Delete a maintenance window","operationId":"deleteV1MaintenancewindowsId","description":"Permanently removes a maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a maintenance window","operationId":"getV1MaintenancewindowsId","description":"Show details of a specific maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a maintenance window","operationId":"putV1MaintenancewindowsId","description":"Updates a maintenance window.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Maintenance windows"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindowCreate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/MaintenanceWindow"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations":{"get":{"summary":"List all private locations","operationId":"getV1Privatelocations","description":"Lists all private locations in your account.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"versions","in":"query","schema":{"type":"boolean","default":false}}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsListSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"post":{"summary":"Create a private location","operationId":"postV1Privatelocations","description":"Creates a new private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"}],"tags":["Private locations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationCreate"}}}},"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commonPrivateLocationSchemaResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}":{"delete":{"summary":"Remove a private location","operationId":"deleteV1PrivatelocationsId","description":"Permanently removes a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a private location","operationId":"getV1PrivatelocationsId","description":"Show details of a specific private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationsSchema"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/NotFoundError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"put":{"summary":"Update a private location","operationId":"putV1PrivatelocationsId","description":"Updates a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationUpdate"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/commonPrivateLocationSchemaResponse"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/keys":{"post":{"summary":"Generate a new API Key for a private location","operationId":"postV1PrivatelocationsIdKeys","description":"Creates an api key on the private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/privateLocationKeys"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/keys/{keyId}":{"delete":{"summary":"Remove an existing API key for a private location","operationId":"deleteV1PrivatelocationsIdKeysKeyid","description":"Permanently removes an api key from a private location.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"id","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"keyId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Private locations"],"responses":{"204":{"description":"No Content"},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v1/private-locations/{id}/metrics":{"get":{"summary":"Get private location health metrics from a window of time.","operationId":"getV1PrivatelocationsIdMetrics","description":"Get private location health metrics from a window of time. @@ -45,4 +45,4 @@ This endpoint will return data within a 6-hour timeframe. If the `from` and `to` You can filter by check type and result type to narrow down the list. Use the `to` and `from` parameters to specify a date range (UNIX timestamp in seconds). Depending on the check type, some fields might be null. -**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v2/check-sessions/{checkSessionId}/completion` or `GET /v2/check-sessions/{checkSessionId}` endpoints to track progress.\n\nUse `POST /v1/check-sessions/{checkSessionId}/cancel` to cancel an in-progress check session.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/check-sessions/{checkSessionId}/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v2/check-sessions/{checkSessionId}` endpoint's response for a completed check session.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/check-sessions/{checkSessionId}/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}}} \ No newline at end of file +**Rate-limiting is applied to this endpoint, you can send 5 requests / 10 seconds at most.**","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true},{"name":"limit","in":"query","schema":{"type":"integer","description":"Limit the number of results to fetch (default 10)","default":10,"minimum":1,"maximum":100},"description":"Limit the number of results to fetch (default 10)"},{"name":"nextId","in":"query","schema":{"type":"string","description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},"description":"Cursor parameter to fetch the next page of results. The \"nextId\" parameter is returned in the response of the previous request. If a response includes a \"nextId\" parameter set to \"null\", there are no more results to fetch."},{"name":"from","in":"query","schema":{"type":"string","format":"date","description":"Select records up from this UNIX timestamp (>= date)."},"description":"Select records up from this UNIX timestamp (>= date)."},{"name":"to","in":"query","schema":{"type":"string","format":"date","description":"Optional. Select records up to this UNIX timestamp (< date)."},"description":"Optional. Select records up to this UNIX timestamp (< date)."},{"name":"location","in":"query","schema":{"type":"string","description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location","enum":["us-east-1","us-east-2","us-west-1","us-west-2","ca-central-1","sa-east-1","eu-west-1","eu-central-1","eu-west-2","eu-west-3","eu-north-1","eu-south-1","me-south-1","ap-southeast-1","ap-northeast-1","ap-east-1","ap-southeast-2","ap-southeast-3","ap-northeast-2","ap-northeast-3","ap-south-1","af-south-1"]},"description":"Provide a data center location, e.g. \"eu-west-1\" to filter by location"},{"name":"checkType","in":"query","schema":{"type":"string","description":"The type of the check","enum":["AGENTIC","API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"description":"The type of the check"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Check result has one or more failures"},"description":"Check result has one or more failures"},{"name":"resultType","in":"query","schema":{"type":"string","description":"The check result type (FINAL,ATTEMPT,ALL)","default":"FINAL","enum":["FINAL","ATTEMPT","ALL"]},"description":"The check result type (FINAL,ATTEMPT,ALL)"}],"tags":["Check results"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckResultListV2"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UnauthorizedError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PaymentRequiredError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ForbiddenError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}}},"/v2/check-sessions/trigger":{"post":{"summary":"Trigger a new check session","operationId":"postV2ChecksessionsTrigger","description":"Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks.\n\nThis endpoint does not wait for the check session to complete. Use the `GET /v2/check-sessions/{checkSessionId}/completion` or `GET /v2/check-sessions/{checkSessionId}` endpoints to track progress.\n\nUse `POST /v1/cancel` to cancel an in-progress check session.\n\nStandard alerting rules apply to finished check runs.\n\nEquivalent to the _Schedule Now_ button in the UI.","tags":["Check sessions","Triggers"],"responses":{"201":{"description":"Created","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"402":{"description":"Payment Required","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2TriggerRequest"}}}}}},"/v2/check-sessions/{checkSessionId}":{"get":{"summary":"Retrieve a check session","operationId":"getV2ChecksessionsChecksessionid","description":"Retrieves a check session. Results may be incomplete if the check session is still in progress.\n\nOnce a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `\"FINAL\"`, and zero or more results with `resultType` equal to `\"ATTEMPT\"` (one for each failed attempt, if any).\n\nEach result contains just enough information to quickly determine whether the check run was successful or not. To dive even deeper into individual results, use the `GET /v1/check-results/{checkId}/{checkResultId}` endpoint to retrieve detailed data about a specific result.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2FindOneResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}},"/v2/check-sessions/{checkSessionId}/completion":{"get":{"summary":"Await the completion of a check session","operationId":"getV2ChecksessionsChecksessionidCompletion","description":"Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled).\n\nIf the check session takes a long time to complete, the endpoint will return a timeout error code. You should keep calling the endpoint until you receive a successful response, or a non-timeout related error code. If using *curl*, its `--retry` option is suitable.\n\nThe successful response of this endpoint is equivalent to the `GET /v2/check-sessions/{checkSessionId}` endpoint's response for a completed check session.\n\nThe `status` field may return `CANCELLED` for sessions cancelled via `POST /v1/cancel`, and each per-result object includes an `isCancelled` boolean.","tags":["Check sessions"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckSessionsV2CompletionResponse"}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"401":{"description":"Unauthorized","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"403":{"description":"Forbidden","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"404":{"description":"Not Found","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"408":{"description":"Request Timeout","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiError"}}}}},"parameters":[{"schema":{"type":"string","format":"uuid","description":"Check session ID."},"required":true,"description":"Check session ID.","name":"checkSessionId","in":"path"},{"schema":{"type":"integer","minimum":1,"maximum":30,"description":"Maximum time to wait for completion before returning a retryable timeout response."},"required":false,"description":"Maximum time to wait for completion before returning a retryable timeout response.","name":"maxWaitSeconds","in":"query"},{"schema":{"type":"string","format":"uuid","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},"required":false,"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","name":"x-checkly-account","in":"header"}]}}}} \ No newline at end of file