diff --git a/API-DOCUMENTATION.md b/API-DOCUMENTATION.md
new file mode 100644
index 00000000..1c5b00d8
--- /dev/null
+++ b/API-DOCUMENTATION.md
@@ -0,0 +1,279 @@
+# API Reference Documentation Architecture
+
+This document outlines how the API reference section is built, maintained, and potential improvements.
+
+## Current Architecture
+
+### Overview
+
+The API reference documentation uses Mintlify's OpenAPI integration. The system has three main components:
+
+```
+┌─────────────────────────────────────────────────────────────────────────┐
+│ docs.json │
+│ - Defines "API" tab with openapi reference │
+│ - Contains 22 navigation groups │
+│ - Lists all 132 page references │
+└─────────────────────────────────────────────────────────────────────────┘
+ │
+ ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│ api-reference/openapi.json │
+│ - 514KB OpenAPI 3.0.0 specification │
+│ - Auto-updated from https://api.checklyhq.com/openapi.json │
+│ - Contains 94 unique API paths │
+│ - Source of truth for all endpoint documentation │
+└─────────────────────────────────────────────────────────────────────────┘
+ │
+ ▼
+┌─────────────────────────────────────────────────────────────────────────┐
+│ api-reference/{category}/*.mdx │
+│ - 132 stub files across 29 subdirectories │
+│ - Minimal content: just frontmatter with `openapi: METHOD /path` │
+│ - Mintlify auto-generates full documentation from OpenAPI spec │
+└─────────────────────────────────────────────────────────────────────────┘
+```
+
+### File Structure
+
+```
+api-reference/
+├── openapi.json # OpenAPI 3.0.0 spec (auto-updated)
+├── accounts/ # 3 files
+├── alert-channels/ # 6 files
+├── alert-notifications/ # 1 file
+├── analytics/ # 8 files
+├── badges/ # 2 files
+├── check-alerts/ # 2 files
+├── check-groups/ # 9 files
+├── check-results/ # 3 files
+├── check-sessions/ # 3 files
+├── check-status/ # 2 files
+├── checks/ # 13 files
+├── client-certificates/ # 4 files
+├── dashboards/ # 5 files
+├── environment-variables/ # 5 files
+├── heartbeats/ # 5 files
+├── incident-updates/ # 3 files
+├── incidents/ # 4 files
+├── location/ # 1 file
+├── maintenance-windows/ # 5 files
+├── monitors/ # 2 files
+├── opentelemetry/ # 1 file (not in nav)
+├── private-locations/ # 8 files
+├── reporting/ # 1 file
+├── runtimes/ # 2 files
+├── snippets/ # 5 files
+├── static-ips/ # 6 files
+├── status-page-incidents/ # 10 files
+├── status-page-services/ # 5 files
+├── status-pages/ # 7 files
+└── triggers/ # 6 files
+```
+
+### MDX File Format
+
+Each MDX file is a minimal stub that references an OpenAPI path:
+
+```yaml
+---
+openapi: get /v1/accounts
+---
+```
+
+Optional fields:
+- `deprecated: true` - marks endpoint as deprecated
+
+Mintlify automatically generates:
+- Endpoint description
+- HTTP method badge (GET/POST/PUT/DELETE)
+- Request parameters table
+- Request body schema
+- Response schemas for all status codes
+- Code examples (cURL, JavaScript, Python)
+- "Try it" interactive playground
+
+### docs.json Configuration
+
+Located at lines 577-863, the API tab is configured as:
+
+```json
+{
+ "tab": "API",
+ "openapi": "api-reference/openapi.json",
+ "groups": [
+ {
+ "group": "Accounts",
+ "pages": [
+ "api-reference/accounts/fetch-user-accounts",
+ "api-reference/accounts/fetch-current-account-details",
+ "api-reference/accounts/fetch-a-given-account-details"
+ ]
+ },
+ // ... 21 more groups
+ ]
+}
+```
+
+### Automation
+
+#### GitHub Actions Workflow
+
+**File:** `.github/workflows/update-api-spec.yml`
+
+- **Schedule:** Runs every 48 hours (cron: `0 2 */2 * *`)
+- **Trigger:** Also supports manual `workflow_dispatch`
+- **Process:**
+ 1. Fetches spec from `https://api.checklyhq.com/openapi.json`
+ 2. Converts HTML tags in descriptions to Markdown
+ 3. Validates with `mintlify openapi-check`
+ 4. Commits directly to `main` if changed
+
+#### Update Script
+
+**File:** `update-api-spec.sh`
+
+```bash
+# Key operations:
+1. Fetch live spec from API
+2. Convert HTML to Markdown ( → [](),
→ \n, → **, → `)
+3. Validate OpenAPI spec
+4. Replace local file
+```
+
+## Current Issues
+
+### 1. MDX/Navigation Sync Issues
+
+The 132 MDX files correctly map to OpenAPI operations (method + path). A single path like `/v1/checks/{id}` can have multiple methods (GET, PUT, DELETE), each requiring its own MDX file.
+
+| Metric | Count |
+|--------|-------|
+| MDX files | 132 |
+| Unique API paths in MDX | 90 |
+| HTTP methods breakdown | GET: 67, POST: 26, PUT: 21, DELETE: 18 |
+
+#### Orphaned MDX Files (exist but not in navigation)
+
+| File | OpenAPI Reference |
+|------|-------------------|
+| `api-reference/opentelemetry/post-accounts-metrics.mdx` | `post /accounts/{accountId}/metrics` |
+
+#### Broken Navigation Links (in docs.json but no MDX file)
+
+| Missing File |
+|--------------|
+| `api-reference/snippets/list-all-snippets.mdx` |
+| `api-reference/snippets/create-a-snippet.mdx` |
+| `api-reference/snippets/retrieve-a-snippet.mdx` |
+| `api-reference/snippets/update-a-snippet.mdx` |
+| `api-reference/snippets/delete-a-snippet.mdx` |
+| `api-reference/detect/uptime-monitoring/url-monitors/overview.mdx` |
+| `api-reference/detect/uptime-monitoring/url-monitors/configuration.mdx` |
+
+**Summary:** 1 orphaned file + 7 broken links = 8 total issues
+
+### 2. Navigation Inconsistencies
+
+- 22 groups in docs.json, 29 subdirectories in filesystem
+- The `opentelemetry/` directory has 1 file but no group in docs.json
+- The `snippets/` group exists in docs.json but files have different names or are missing
+
+### 3. Naming Inconsistencies
+
+- Mixed patterns: `list-all-*` vs `lists-all-*`
+- Some verbose names: `retrieve-all-checks-in-a-specific-group-with-group-settings-applied`
+- Inconsistent verb usage: `fetch` vs `retrieve` vs `get` vs `list`
+
+### 4. Orphaned Files
+
+- Multiple backup files: `openapi.json.backup*`
+- Directories with files not in docs.json navigation
+
+### 5. Manual Synchronization Required
+
+- When API spec adds/removes endpoints, MDX files and docs.json must be manually updated
+- No automation for generating new MDX stubs or updating navigation
+
+## Potential Improvements
+
+### Short-term
+
+1. **Audit and cleanup**
+ - Remove orphaned MDX files that don't map to OpenAPI paths
+ - Delete backup files
+ - Add missing pages to docs.json or remove unused directories
+
+2. **Fix broken links**
+ - Verify all docs.json page references have corresponding MDX files
+ - Verify all MDX `openapi:` references exist in openapi.json
+
+3. **Standardize naming**
+ - Establish naming conventions (e.g., always `list-` not `lists-`)
+ - Keep names concise but descriptive
+
+### Medium-term
+
+4. **Automate MDX generation**
+ - Script to generate MDX stubs from OpenAPI paths
+ - Script to update docs.json navigation from OpenAPI tags
+ - Run as part of the update-api-spec workflow
+
+5. **Leverage OpenAPI tags**
+ - OpenAPI spec likely has tags for grouping endpoints
+ - Could auto-generate navigation structure from tags
+
+### Long-term
+
+6. **Consider Mintlify auto-generation**
+ - Mintlify can auto-generate pages from OpenAPI spec
+ - May eliminate need for individual MDX files
+ - Trade-off: less control over URL structure and organization
+
+## API Endpoints Summary
+
+### By Category (from OpenAPI spec paths)
+
+| Category | Endpoints |
+|----------|-----------|
+| accounts | 3 |
+| alert-channels | 3 |
+| alert-notifications | 1 |
+| analytics | 8 |
+| badges | 2 |
+| check-alerts | 2 |
+| check-groups | 4 |
+| check-results | 2 |
+| check-sessions | 3 |
+| check-statuses | 2 |
+| checks | 18 |
+| client-certificates | 2 |
+| dashboards | 2 |
+| incidents | 4 |
+| locations | 1 |
+| maintenance-windows | 2 |
+| private-locations | 5 |
+| reporting | 1 |
+| runtimes | 2 |
+| snippets | 2 |
+| static-ips | 6 |
+| status-pages | 12 |
+| triggers | 2 |
+| variables | 2 |
+
+## Related Files
+
+| File | Purpose |
+|------|---------|
+| `docs.json` | Main config, API nav at lines 577-863 |
+| `api-reference/openapi.json` | OpenAPI 3.0.0 specification |
+| `update-api-spec.sh` | Script to fetch and process spec |
+| `.github/workflows/update-api-spec.yml` | Automation workflow |
+
+## Questions to Resolve
+
+1. Should we automate MDX stub generation when the OpenAPI spec changes?
+2. Should we consolidate some navigation groups (22 seems high)?
+3. Is the opentelemetry endpoint intentionally hidden from navigation?
+4. Should deprecated endpoints be removed or kept for backwards compatibility?
+5. Would Mintlify's auto-generation feature be preferable to manual MDX files?
diff --git a/api-reference/accounts/fetch-a-given-account-details.mdx b/api-reference/accounts/fetch-a-given-account-details.mdx
index 002f5382..994510a3 100644
--- a/api-reference/accounts/fetch-a-given-account-details.mdx
+++ b/api-reference/accounts/fetch-a-given-account-details.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/accounts/{accountId}
+title: Get details for a specific account
---
\ No newline at end of file
diff --git a/api-reference/accounts/fetch-current-account-details.mdx b/api-reference/accounts/fetch-current-account-details.mdx
index d83468f9..948955f4 100644
--- a/api-reference/accounts/fetch-current-account-details.mdx
+++ b/api-reference/accounts/fetch-current-account-details.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/accounts/me
+title: Get details for the current account
---
\ No newline at end of file
diff --git a/api-reference/accounts/fetch-user-accounts.mdx b/api-reference/accounts/fetch-user-accounts.mdx
index a7630a34..05fd88ec 100644
--- a/api-reference/accounts/fetch-user-accounts.mdx
+++ b/api-reference/accounts/fetch-user-accounts.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/accounts
+title: Get details for all accounts
---
\ No newline at end of file
diff --git a/api-reference/analytics/api-checks.mdx b/api-reference/analytics/api-checks.mdx
index d112a860..981347f7 100644
--- a/api-reference/analytics/api-checks.mdx
+++ b/api-reference/analytics/api-checks.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/api-checks/{id}
+title: Get API Check analytics
---
\ No newline at end of file
diff --git a/api-reference/badges/get-v1badgeschecks.mdx b/api-reference/badges/get-v1badgeschecks.mdx
index 7cd48f9b..93ef23e9 100644
--- a/api-reference/badges/get-v1badgeschecks.mdx
+++ b/api-reference/badges/get-v1badgeschecks.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/badges/checks/{checkId}
+title: Get badge for a check
---
\ No newline at end of file
diff --git a/api-reference/badges/get-v1badgesgroups.mdx b/api-reference/badges/get-v1badgesgroups.mdx
index db6e71fd..03e001bc 100644
--- a/api-reference/badges/get-v1badgesgroups.mdx
+++ b/api-reference/badges/get-v1badgesgroups.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/badges/groups/{groupId}
+title: Get badge for a group
---
\ No newline at end of file
diff --git a/api-reference/checks/create-a-tcp-check.mdx b/api-reference/checks/create-a-tcp-check.mdx
index aec433f3..46f8fbe7 100644
--- a/api-reference/checks/create-a-tcp-check.mdx
+++ b/api-reference/checks/create-a-tcp-check.mdx
@@ -1,3 +1,4 @@
---
openapi: post /v1/checks/tcp
+title: Create a TCP monitor
---
\ No newline at end of file
diff --git a/api-reference/checks/update-an-tcp-check.mdx b/api-reference/checks/update-an-tcp-check.mdx
index 9525f285..0766d2b8 100644
--- a/api-reference/checks/update-an-tcp-check.mdx
+++ b/api-reference/checks/update-an-tcp-check.mdx
@@ -1,3 +1,4 @@
---
openapi: put /v1/checks/tcp/{id}
+title: Update a TCP monitor
---
\ No newline at end of file
diff --git a/api-reference/client-certificates/creates-a-new-client-certificate.mdx b/api-reference/client-certificates/creates-a-new-client-certificate.mdx
index e94ea0c2..9c840359 100644
--- a/api-reference/client-certificates/creates-a-new-client-certificate.mdx
+++ b/api-reference/client-certificates/creates-a-new-client-certificate.mdx
@@ -1,3 +1,4 @@
---
openapi: post /v1/client-certificates
+title: Create a client certificate
---
\ No newline at end of file
diff --git a/api-reference/client-certificates/deletes-a-client-certificate.mdx b/api-reference/client-certificates/deletes-a-client-certificate.mdx
index be4be504..df468258 100644
--- a/api-reference/client-certificates/deletes-a-client-certificate.mdx
+++ b/api-reference/client-certificates/deletes-a-client-certificate.mdx
@@ -1,3 +1,4 @@
---
openapi: delete /v1/client-certificates/{id}
+title: Delete a client certificate
---
\ No newline at end of file
diff --git a/api-reference/client-certificates/lists-all-client-certificates.mdx b/api-reference/client-certificates/lists-all-client-certificates.mdx
index 172165cb..c3920130 100644
--- a/api-reference/client-certificates/lists-all-client-certificates.mdx
+++ b/api-reference/client-certificates/lists-all-client-certificates.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/client-certificates
+title: List all client certificates
---
\ No newline at end of file
diff --git a/api-reference/client-certificates/shows-one-client-certificate.mdx b/api-reference/client-certificates/shows-one-client-certificate.mdx
index 790af7f4..587bd3ee 100644
--- a/api-reference/client-certificates/shows-one-client-certificate.mdx
+++ b/api-reference/client-certificates/shows-one-client-certificate.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/client-certificates/{id}
+title: Retrieve a client certificate
---
\ No newline at end of file
diff --git a/api-reference/environment-variables/create-an-environment-variable.mdx b/api-reference/environment-variables/create-an-environment-variable.mdx
index 23de3294..874b0098 100644
--- a/api-reference/environment-variables/create-an-environment-variable.mdx
+++ b/api-reference/environment-variables/create-an-environment-variable.mdx
@@ -1,3 +1,4 @@
---
openapi: post /v1/variables
+title: Create an environment variable
---
\ No newline at end of file
diff --git a/api-reference/heartbeats/create-a-heartbeat-check.mdx b/api-reference/heartbeats/create-a-heartbeat-check.mdx
index d9f30bcd..83c2e109 100644
--- a/api-reference/heartbeats/create-a-heartbeat-check.mdx
+++ b/api-reference/heartbeats/create-a-heartbeat-check.mdx
@@ -1,3 +1,4 @@
---
openapi: post /v1/checks/heartbeat
+title: Create a heartbeat monitor
---
\ No newline at end of file
diff --git a/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat.mdx b/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat.mdx
index 75d1674b..23caefeb 100644
--- a/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat.mdx
+++ b/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/events
+title: List all events for a heartbeat monitor
---
\ No newline at end of file
diff --git a/api-reference/heartbeats/get-a-specific-heartbeat-event.mdx b/api-reference/heartbeats/get-a-specific-heartbeat-event.mdx
index e468d73f..7a1fa14a 100644
--- a/api-reference/heartbeats/get-a-specific-heartbeat-event.mdx
+++ b/api-reference/heartbeats/get-a-specific-heartbeat-event.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/events/{id}
+title: List a specific event for a heartbeat monitor
---
\ No newline at end of file
diff --git a/api-reference/heartbeats/get-heartbeat-availability.mdx b/api-reference/heartbeats/get-heartbeat-availability.mdx
index ad9d11f9..45440da4 100644
--- a/api-reference/heartbeats/get-heartbeat-availability.mdx
+++ b/api-reference/heartbeats/get-heartbeat-availability.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/checks/heartbeats/{checkId}/availability
+title: Get heartbeat monitor availability
---
\ No newline at end of file
diff --git a/api-reference/heartbeats/update-a-heartbeat-check.mdx b/api-reference/heartbeats/update-a-heartbeat-check.mdx
index cf16aed9..d162cff5 100644
--- a/api-reference/heartbeats/update-a-heartbeat-check.mdx
+++ b/api-reference/heartbeats/update-a-heartbeat-check.mdx
@@ -1,3 +1,4 @@
---
openapi: put /v1/checks/heartbeat/{id}
+title: Update a heartbeat monitor
---
\ No newline at end of file
diff --git a/api-reference/monitors/create-a-url-monitor.mdx b/api-reference/monitors/create-a-url-monitor.mdx
index 8d4af293..e3623628 100644
--- a/api-reference/monitors/create-a-url-monitor.mdx
+++ b/api-reference/monitors/create-a-url-monitor.mdx
@@ -1,3 +1,4 @@
---
openapi: post /v1/checks/url
+title: Create a URL monitor
---
\ No newline at end of file
diff --git a/api-reference/monitors/update-an-url-monitor.mdx b/api-reference/monitors/update-an-url-monitor.mdx
index cd0548a2..0c12a382 100644
--- a/api-reference/monitors/update-an-url-monitor.mdx
+++ b/api-reference/monitors/update-an-url-monitor.mdx
@@ -1,3 +1,4 @@
---
openapi: put /v1/checks/url/{id}
+title: Update a URL monitor
---
\ No newline at end of file
diff --git a/api-reference/openapi.json b/api-reference/openapi.json
index 693cf584..64b3914b 100644
--- a/api-reference/openapi.json
+++ b/api-reference/openapi.json
@@ -1,39 +1,40 @@
-{"servers":[{"url":"https://api.checklyhq.com"}],"info":{"title":"Checkly Public API","version":"v1","description":"These are the docs for the newly released Checkly Public API.
If you have any questions, please do not hesitate to get in touch with us."},"security":[{"Bearer":[]}],"openapi":"3.0.0","components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"Bearer","description":"The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys).
+{"servers":[{"url":"https://api.checklyhq.com"}],"info":{"title":"Checkly Public API","version":"v1","description":"These are the docs for the newly released Checkly Public API.
+If you have any questions, please do not hesitate to get in touch with us."},"security":[{"Bearer":[]}],"openapi":"3.0.0","components":{"securitySchemes":{"Bearer":{"type":"http","scheme":"bearer","bearerFormat":"Bearer","description":"The Checkly Public API uses API keys to authenticate requests. You can get the API Key [here](https://app.checklyhq.com/settings/user/api-keys).
Your API key is like a password:
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":{"Model1":{"type":"object"},"messages":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Model1"}},"agent":{"type":"string","default":"basic","enum":["basic","checkly_config_generator","playwright_check_generator"]},"Model2":{"type":"object","properties":{"messages":{"$ref":"#/components/schemas/messages"},"agent":{"$ref":"#/components/schemas/agent"}},"required":["messages"]},"Model3":{"type":"object","properties":{"startTime":{"description":"Start time as Unix timestamp in seconds or milliseconds","anyOf":[{"type":"string","format":"date"},{"type":"integer"}]},"endTime":{"description":"End time as Unix timestamp in seconds or milliseconds","anyOf":[{"type":"string","format":"date"},{"type":"integer"}]},"query":{"type":"string","description":"Prometheus query string"},"step":{"type":"number","description":"Query resolution step width in seconds","default":60}},"required":["query"]},"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"},"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"]},"Model4":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model4"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model5":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model5"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model6":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model6"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"type":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","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/type"},"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"}},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/type"},"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","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":["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":["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":["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"}}},"Model14":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model15":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model14"},"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/Model15"}}},"Model17":{"type":"array","items":{"type":"string"}},"Model18":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model19":{"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"}}},"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":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"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"}}},"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":["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"}}},"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"}}},"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"}}},"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"}}},"Model25":{"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"}}},"Model26":{"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":{"$ref":"#/components/schemas/Model25"}}},"Model27":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"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/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"]},"Model29":{"type":"string","description":"The type of the check.","example":"API","enum":["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/Model29"},"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"}},"Model30":{"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/Model30"}},"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,"maxItems":50,"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":[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"}}},"Model31":{"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/Model31"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":"null","enum":["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"}},"Model32":{"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"]},"Model33":{"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/Model32"}},"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"}}},"Model34":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["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":50,"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"}}},"Model35":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model36":{"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/Model33"},"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/Model34"},"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/Model35"},"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/Model36"},"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"]},"Model37":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model37"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model38":{"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"]},"Model39":{"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/Model38"}},"Model40":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model41":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model42":{"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/Model39"},"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/Model40"},"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/Model41"},"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/Model42"},"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"}]}}},"Model43":{"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"}},"Model44":{"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/Model44"},"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"}}},"Model45":{"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/Model45"},"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"}}},"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"]},"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},"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"},"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}}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model46":{"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/Model46"}},"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"}}},"Model47":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model48":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"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/Model47"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model48"},"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"}},"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"]},"Model49":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model50":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT"]},"Model51":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model52":{"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/Model51"},"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/Model52"},"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":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted"]},"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/Model49"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model50"},"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"},"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"]},"Model53":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model54":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT"]},"Model55":{"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/Model53"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model54"},"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"},"results":{"$ref":"#/components/schemas/Model55"}},"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"}},"Model56":{"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/Model56"}},"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"}}},"Model57":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model58":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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":50,"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/Model57"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model58"},"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},"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"]},"Model59":{"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"]},"Model60":{"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/Model59"}},"Model61":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model62":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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"]},"Model63":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model64":{"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/Model63"},"queryParameters":{"$ref":"#/components/schemas/Model64"},"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/Model60"},"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/Model61"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model62"},"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},"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"]},"Model65":{"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"]},"Model66":{"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/Model65"}},"Model67":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["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"}},"Model68":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model69":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model70":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model68"},"headers":{"$ref":"#/components/schemas/Model69"},"queryParameters":{"$ref":"#/components/schemas/Model70"}},"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"}}},"Model71":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model72":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model73":{"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/Model71"},"queryParameters":{"$ref":"#/components/schemas/Model72"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model74":{"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/Model66"},"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/Model67"},"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},"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/Model73"},"checkType":{"$ref":"#/components/schemas/Model74"},"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"]},"Model75":{"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"]},"Model76":{"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/Model75"}},"Model77":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model78":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model79":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model80":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model81":{"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/Model79"},"queryParameters":{"$ref":"#/components/schemas/Model80"},"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/Model76"},"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/Model77"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model78"},"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},"request":{"$ref":"#/components/schemas/Model81"},"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}}},"Model82":{"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"]},"Model83":{"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/Model82"}},"Model84":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model85":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model86":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"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/Model83"},"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/Model84"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model85"},"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},"environmentVariables":{"$ref":"#/components/schemas/Model86"},"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"]},"Model87":{"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"]},"Model88":{"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/Model87"}},"Model89":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model90":{"type":"string","enum":["BROWSER"]},"Model91":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":50,"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/Model88"},"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/Model89"},"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},"checkType":{"$ref":"#/components/schemas/Model90"},"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/Model91"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model92":{"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"]},"Model93":{"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/Model92"}},"Model94":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model95":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model96":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"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/Model93"},"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/Model94"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model95"},"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},"environmentVariables":{"$ref":"#/components/schemas/Model96"},"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}}},"Model97":{"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"]},"Model98":{"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/Model97"}},"Model99":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model100":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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"]},"Model101":{"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/Model101"}},"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"]},"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/Model98"},"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/Model99"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model100"},"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},"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}},"required":["name","request","heartbeat","script"]},"Model102":{"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"]},"Model103":{"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/Model102"}},"Model104":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model105":{"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/Model103"},"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/Model104"},"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},"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"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model105"}},"required":["name"]},"Model106":{"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"]},"Model107":{"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/Model106"}},"Model108":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model109":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model110":{"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/Model107"},"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/Model108"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model109"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"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/Model110"},"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"]},"Model111":{"type":"string","enum":["HEARTBEAT"]},"Model112":{"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},"checkType":{"$ref":"#/components/schemas/Model111"},"heartbeat":{"$ref":"#/components/schemas/Model112"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model113":{"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"]},"Model114":{"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/Model113"}},"Model115":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model116":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model117":{"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/Model114"},"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/Model115"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model116"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"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/Model117"},"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"}}},"Model118":{"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"]},"Model119":{"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/Model119"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model118"},"last7Days":{"$ref":"#/components/schemas/Model118"}}},"Model120":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model121":{"type":"array","items":{"$ref":"#/components/schemas/Model120"}},"Model122":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model119"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model123":{"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"]},"Model124":{"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/Model123"}},"Model125":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model126":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_ANSWER"]},"IcmpMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN"]},"Model127":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/IcmpMonitorAssertionComparison"},"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/Model127"}},"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/ipFamily"},"pingCount":{"type":"integer","default":10,"minimum":1,"maximum":10},"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/Model124"},"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/Model125"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model126"},"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},"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":"integer","description":"The packet loss percentage threshold for degraded state.","default":10,"minimum":0,"maximum":100},"maxPacketLossThreshold":{"type":"integer","description":"The packet loss percentage threshold for failed state.","default":20,"minimum":0,"maximum":100}},"required":["name","request","heartbeat","script"]},"Model128":{"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"]},"Model129":{"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/Model128"}},"Model130":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model131":{"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/Model129"},"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/Model130"},"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},"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},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model131"}},"required":["name"]},"Model132":{"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"]},"Model133":{"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/Model132"}},"Model134":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model135":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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/Model133"},"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/Model134"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model135"},"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},"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":"integer","description":"The packet loss percentage threshold for degraded state.","default":10,"minimum":0,"maximum":100},"maxPacketLossThreshold":{"type":"integer","description":"The packet loss percentage threshold for failed state.","default":20,"minimum":0,"maximum":100},"privateLocations":{"type":"string"}},"required":["heartbeat","script"]},"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":["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/Model31"}},"Model140":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model141":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model142":{"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/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},"checkType":{"$ref":"#/components/schemas/Model140"},"environmentVariables":{"$ref":"#/components/schemas/Model141"},"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/Model142"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model143":{"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"]},"Model144":{"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/Model143"}},"Model145":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model146":{"type":"string","enum":["MULTI_STEP"]},"Model147":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":50,"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/Model144"},"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/Model145"},"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},"checkType":{"$ref":"#/components/schemas/Model146"},"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/Model147"}},"required":["name","script"]},"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":["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/Model31"}},"Model152":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model153":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model154":{"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/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},"checkType":{"$ref":"#/components/schemas/Model152"},"environmentVariables":{"$ref":"#/components/schemas/Model153"},"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/Model154"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model155":{"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"]},"Model156":{"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/Model155"}},"Model157":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model158":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model159":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model159"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model160":{"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"}},"Model161":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model160"},"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/Model156"},"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/Model157"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model158"},"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},"request":{"$ref":"#/components/schemas/Model161"},"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"]},"Model162":{"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"]},"Model163":{"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/Model162"}},"Model164":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model165":{"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"}},"Model166":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model165"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model167":{"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/Model163"},"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/Model164"},"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},"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/Model166"},"checkType":{"$ref":"#/components/schemas/Model167"}},"required":["name"]},"Model168":{"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"]},"Model169":{"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/Model168"}},"Model170":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model171":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model172":{"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"}},"Model173":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model172"},"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/Model169"},"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/Model170"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model171"},"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},"request":{"$ref":"#/components/schemas/Model173"},"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"}}},"Model174":{"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"]},"Model175":{"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/Model174"}},"Model176":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model177":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model178":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model179":{"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/Model179"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model178"},"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"]},"Model180":{"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/Model175"},"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/Model176"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model177"},"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},"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"]},"Model181":{"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"]},"Model182":{"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/Model181"}},"Model183":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model184":{"type":"string","default":"GET","enum":["GET"]},"Model185":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model184"},"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"]},"Model186":{"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/Model182"},"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/Model183"},"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},"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/Model185"},"checkType":{"$ref":"#/components/schemas/Model186"}},"required":["name"]},"Model187":{"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"]},"Model188":{"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/Model187"}},"Model189":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model190":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model191":{"type":"string","default":"GET","enum":["GET"]},"Model192":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model191"},"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/Model188"},"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/Model189"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model190"},"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},"request":{"$ref":"#/components/schemas/Model192"},"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"}}},"Model193":{"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"]},"Model194":{"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/Model193"}},"Model195":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model196":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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/Model194"},"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/Model195"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model196"},"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},"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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"]},"Model197":{"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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"}}},"Model198":{"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"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model198"}},"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"}},"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"]},"Model199":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model200":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model199"},"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/Model200"}},"Model201":{"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"]},"Model202":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model203":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model202"},"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"]},"Model204":{"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/Model203"}},"Model205":{"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/Model204"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model206":{"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"]},"Model207":{"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/Model203"}},"Model208":{"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"]},"Location":{"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/Location"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"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"},"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},"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"},"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}},"required":["name","startsAt","endsAt","repeatUnit"]},"CheckAssignment":{"type":"object","properties":{"id":{"type":"string","example":"4295d566-18bd-47ef-b22b-129a64ffd589","x-format":{"guid":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"25039e6d-8631-4ee8-950a-bf7c893c3c1c","x-format":{"guid":true}},"privateLocationId":{"type":"string","description":"The ID of the assigned private location.","example":"cc3f943d-7a99-49f4-94aa-bddbaaad6eb0","x-format":{"guid":true}}},"required":["id","checkId","privateLocationId"]},"checkAssignments":{"type":"array","description":"The check this private location has assigned.","items":{"$ref":"#/components/schemas/CheckAssignment"}},"GroupAssignment":{"type":"object","properties":{"id":{"type":"string","example":"450d2f06-2300-46ed-8982-b63cd53fc494","x-format":{"guid":true}},"groupId":{"type":"number","description":"The ID of the group.","example":10},"privateLocationId":{"type":"string","description":"The ID of the assigned private location.","example":"895c13cc-7de2-46df-9985-cb01b995a3cf","x-format":{"guid":true}}},"required":["id","groupId","privateLocationId"]},"groupAssignments":{"type":"array","description":"The group this private location has assigned.","items":{"$ref":"#/components/schemas/GroupAssignment"}},"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"]},"Model209":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"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},"checkAssignments":{"$ref":"#/components/schemas/checkAssignments"},"groupAssignments":{"$ref":"#/components/schemas/groupAssignments"},"keys":{"$ref":"#/components/schemas/Model209"},"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}},"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"]},"Model210":{"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},"checkAssignments":{"$ref":"#/components/schemas/checkAssignments"},"groupAssignments":{"$ref":"#/components/schemas/groupAssignments"},"keys":{"$ref":"#/components/schemas/Model210"},"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"}},"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.51.1","@axe-core/playwright":"4.10.1","@azure/identity":"4.9.1","@azure/keyvault-secrets":"4.9.0","@checkly/playwright-helpers":"1.0.3","@faker-js/faker":"9.7.0","@google-cloud/local-auth":"3.0.1","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.53.0","@opentelemetry/sdk-metrics":"1.26.0","@opentelemetry/sdk-trace-base":"1.26.0","@t3-oss/env-nextjs":"0.11.1","@xmldom/xmldom":"0.9.2","aws4":"1.13.2","axios":"0.28.0","btoa":"1.2.1","http":"22.11.0","https":"22.11.0","crypto-js":"4.2.0","date-fns":"3.3.1","date-fns-tz":"3.1.3","dotenv":"16.4.5","ethers":"6.13.2","expect":"29.7.0","form-data":"4.0.4","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"9.14.1","googleapis":"144.0.0","graphql":"16.9.0","graphql-tag":"2.12.6","jose":"5.9.2","jsdom":"25.0.0","jsonwebtoken":"9.0.2","lodash":"4.17.21","long":"5.2.3","moment":"2.30.1","nice-grpc":"2.1.12","nice-grpc-client-middleware-deadline":"2.0.15","nice-grpc-client-middleware-devtools":"1.0.7","nice-grpc-client-middleware-retry":"3.1.11","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.9","nice-grpc-opentelemetry":"0.1.18","nice-grpc-prometheus":"0.2.7","nice-grpc-server-health":"2.0.14","nice-grpc-server-middleware-terminator":"2.0.14","nice-grpc-server-reflection":"2.0.14","nice-grpc-web":"3.3.7","node-pop3":"0.9.1","otpauth":"9.4.0","playwright":"1.51.1","pdf2json":"3.1.4","prisma":"6.6.0","protobufjs":"7.5.0","tedious":"18.6.1","twilio":"5.3.0","uuid":"11.1.0","ws":"8.18.1","xml-crypto":"6.1.1","xml-encryption":"3.1.0","zod":"3.24.3","@clerk/testing":"1.5.1","mailosaur":"8.6.1","gaxios":"6.7.1","@kubernetes/client-node":"1.1.2","mysql":"2.18.1"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2025.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.51.1"},"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-01-17T02:37:26.561Z"},"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"},"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"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"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"}},"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"}},"StatusPageV2Update":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"}},"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"},"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-01-17T02:37:26.619Z"},"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"},"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"}},"required":["name","severity","services"]},"Model211":{"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"]},"Model212":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model213":{"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/Model212"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model213"},"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"}},"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"]},"Model214":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model215":{"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"]},"Model216":{"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/Model215"}},"Model217":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model218":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model219":{"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"]},"Model220":{"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]}}},"Model221":{"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]}}},"Model222":{"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":[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/Model220"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model221"},"reminders":{"$ref":"#/components/schemas/Model222"},"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/Model216"},"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/Model217"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model218"},"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/Model219"},"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"]}}},"tags":[],"paths":{"/accounts/{accountId}/ai/agents/stream":{"post":{"operationId":"postAccountsAccountidAiAgentsStream","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model2"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/accounts/{accountId}/metrics":{"post":{"operationId":"postAccountsAccountidMetrics","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["opentelemetry","metrics"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model3"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts":{"get":{"summary":"[beta] Fetch user accounts","operationId":"getV1Accounts","description":"**[beta]** List account details based on supplied API key. (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/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":"[beta] Fetch current account details","operationId":"getV1AccountsMe","description":"**[beta]** Get details from the current account (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/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/{accountId}":{"get":{"summary":"[beta] Fetch a given account details","operationId":"getV1AccountsAccountid","description":"**[beta]** Get details from a specific account. (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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/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":{"Model1":{"type":"object"},"messages":{"type":"array","minItems":1,"items":{"$ref":"#/components/schemas/Model1"}},"agent":{"type":"string","default":"basic","enum":["basic","checkly_config_generator","playwright_check_generator"]},"Model2":{"type":"object","properties":{"messages":{"$ref":"#/components/schemas/messages"},"agent":{"$ref":"#/components/schemas/agent"}},"required":["messages"]},"Model3":{"type":"object","properties":{"startTime":{"description":"Start time as Unix timestamp in seconds or milliseconds","anyOf":[{"type":"string","format":"date"},{"type":"integer"}]},"endTime":{"description":"End time as Unix timestamp in seconds or milliseconds","anyOf":[{"type":"string","format":"date"},{"type":"integer"}]},"query":{"type":"string","description":"Prometheus query string"},"step":{"type":"number","description":"Query resolution step width in seconds","default":60}},"required":["query"]},"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"},"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"]},"Model4":{"type":"string","enum":["Forbidden"]},"ForbiddenError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[403]},"error":{"$ref":"#/components/schemas/Model4"},"message":{"type":"string","example":"Forbidden"}},"required":["statusCode","error"]},"Model5":{"type":"string","enum":["Too Many Requests"]},"TooManyRequestsError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[429]},"error":{"$ref":"#/components/schemas/Model5"},"message":{"type":"string","example":"Too Many Requests"},"attributes":{"$ref":"#/components/schemas/attributes"}},"required":["statusCode","error"]},"Model6":{"type":"string","enum":["Not Found"]},"NotFoundError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[404]},"error":{"$ref":"#/components/schemas/Model6"},"message":{"type":"string","example":"Not Found"}},"required":["statusCode","error"]},"type":{"type":"string","example":"SMS","enum":["EMAIL","SLACK","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/type"},"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"}},"AlertChannelCreateConfig":{"type":"object"},"AlertChannelCreate":{"type":"object","properties":{"subscriptions":{"$ref":"#/components/schemas/AlertChanelSubscriptionList"},"type":{"$ref":"#/components/schemas/type"},"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","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":["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":["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":["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"}}},"Model14":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model15":{"type":"object","properties":{"availability":{"$ref":"#/components/schemas/availability"},"retries":{"$ref":"#/components/schemas/retries"}}},"Model16":{"type":"object","properties":{"checkId":{"type":"string","x-format":{"guid":true}},"name":{"type":"string"},"checkType":{"$ref":"#/components/schemas/Model14"},"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/Model15"}}},"Model17":{"type":"array","items":{"type":"string"}},"Model18":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model19":{"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"}}},"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":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model22":{"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"}}},"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":["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"}}},"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"}}},"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"}}},"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"}}},"Model25":{"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"}}},"Model26":{"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":{"$ref":"#/components/schemas/Model25"}}},"Model27":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model28":{"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/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"]},"Model29":{"type":"string","description":"The type of the check.","example":"API","enum":["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/Model29"},"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"}},"Model30":{"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/Model30"}},"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,"maxItems":50,"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":[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"}}},"Model31":{"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/Model31"}},"runtimeId":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","example":"null","enum":["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"}},"Model32":{"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"]},"Model33":{"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/Model32"}},"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"}}},"Model34":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["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":50,"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"}}},"Model35":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model36":{"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/Model33"},"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/Model34"},"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/Model35"},"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/Model36"},"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"]},"Model37":{"type":"string","enum":["Conflict"]},"ConflictError":{"type":"object","properties":{"statusCode":{"type":"number","enum":[409]},"error":{"$ref":"#/components/schemas/Model37"},"message":{"type":"string","example":"Conflict"}},"required":["statusCode","error"]},"Model38":{"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"]},"Model39":{"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/Model38"}},"Model40":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model41":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model42":{"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/Model39"},"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/Model40"},"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/Model41"},"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/Model42"},"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"}]}}},"Model43":{"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"}},"Model44":{"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/Model44"},"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"}}},"Model45":{"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/Model45"},"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"}}},"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"]},"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},"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"},"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}}},"required":["resultType"]},"CheckResultList":{"type":"array","items":{"$ref":"#/components/schemas/CheckResult"}},"Model46":{"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/Model46"}},"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"}}},"Model47":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model48":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT"]},"runLocations":{"type":"array","description":"The run locations of the check session.","example":["us-east-1","eu-central-1"],"items":{"type":"string"}},"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/Model47"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model48"},"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"}},"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"]},"Model49":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model50":{"type":"string","description":"The status of the check session.","example":"PASSED","enum":["STARTED","PROGRESS","FAILED","PASSED","DEGRADED","PROGRESS_FAILED","PROGRESS_DEGRADED","TIMED_OUT"]},"Model51":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model52":{"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/Model51"},"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/Model52"},"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":["checkResultId","checkResultLink","checkId","checkType","runLocation","resultType","hasErrors","hasFailures","isDegraded","aborted"]},"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/Model49"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model50"},"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"},"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"]},"Model53":{"type":"string","example":"API","enum":["API","BROWSER","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"Model54":{"type":"string","description":"The final status of the check session.","example":"PASSED","enum":["FAILED","PASSED","DEGRADED","TIMED_OUT"]},"Model55":{"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/Model53"},"name":{"type":"string","example":"Example API Check"},"status":{"$ref":"#/components/schemas/Model54"},"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"},"results":{"$ref":"#/components/schemas/Model55"}},"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"}},"Model56":{"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/Model56"}},"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"}}},"Model57":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model58":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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":50,"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/Model57"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model58"},"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},"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"]},"Model59":{"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"]},"Model60":{"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/Model59"}},"Model61":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model62":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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"]},"Model63":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model64":{"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/Model63"},"queryParameters":{"$ref":"#/components/schemas/Model64"},"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/Model60"},"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/Model61"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model62"},"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},"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"]},"Model65":{"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"]},"Model66":{"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/Model65"}},"Model67":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["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"}},"Model68":{"type":"string","default":"POST","enum":["GET","POST","PUT","HEAD","DELETE","PATCH"],"nullable":true},"Model69":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model70":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"CheckAlertWebhook":{"type":"object","properties":{"name":{"type":"string","default":""},"url":{"type":"string","default":""},"method":{"$ref":"#/components/schemas/Model68"},"headers":{"$ref":"#/components/schemas/Model69"},"queryParameters":{"$ref":"#/components/schemas/Model70"}},"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"}}},"Model71":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model72":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model73":{"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/Model71"},"queryParameters":{"$ref":"#/components/schemas/Model72"},"assertions":{"$ref":"#/components/schemas/AssertionList"},"basicAuth":{"$ref":"#/components/schemas/BasicAuth"}},"required":["method","url"]},"Model74":{"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/Model66"},"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/Model67"},"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},"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/Model73"},"checkType":{"$ref":"#/components/schemas/Model74"},"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"]},"Model75":{"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"]},"Model76":{"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/Model75"}},"Model77":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model78":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model79":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model80":{"type":"array","items":{"$ref":"#/components/schemas/KeyValue"}},"Model81":{"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/Model79"},"queryParameters":{"$ref":"#/components/schemas/Model80"},"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/Model76"},"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/Model77"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model78"},"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},"request":{"$ref":"#/components/schemas/Model81"},"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}}},"Model82":{"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"]},"Model83":{"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/Model82"}},"Model84":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model85":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model86":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"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/Model83"},"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/Model84"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model85"},"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},"environmentVariables":{"$ref":"#/components/schemas/Model86"},"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"]},"Model87":{"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"]},"Model88":{"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/Model87"}},"Model89":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model90":{"type":"string","enum":["BROWSER"]},"Model91":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":50,"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/Model88"},"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/Model89"},"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},"checkType":{"$ref":"#/components/schemas/Model90"},"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/Model91"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name","script"]},"Model92":{"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"]},"Model93":{"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/Model92"}},"Model94":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model95":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model96":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"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/Model93"},"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/Model94"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model95"},"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},"environmentVariables":{"$ref":"#/components/schemas/Model96"},"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}}},"Model97":{"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"]},"Model98":{"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/Model97"}},"Model99":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model100":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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"]},"Model101":{"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/Model101"}},"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"]},"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/Model98"},"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/Model99"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model100"},"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},"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}},"required":["name","request","heartbeat","script"]},"Model102":{"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"]},"Model103":{"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/Model102"}},"Model104":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model105":{"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/Model103"},"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/Model104"},"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},"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"},"request":{"$ref":"#/components/schemas/DnsMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model105"}},"required":["name"]},"Model106":{"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"]},"Model107":{"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/Model106"}},"Model108":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model109":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"periodUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"graceUnit":{"type":"string","enum":["seconds","minutes","hours","days"]},"Model110":{"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/Model107"},"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/Model108"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model109"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"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/Model110"},"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"]},"Model111":{"type":"string","enum":["HEARTBEAT"]},"Model112":{"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},"checkType":{"$ref":"#/components/schemas/Model111"},"heartbeat":{"$ref":"#/components/schemas/Model112"},"alertChannels":{"$ref":"#/components/schemas/CheckAlertChannels"},"created_at":{"type":"string","format":"date"},"updated_at":{"type":"string","format":"date-time","nullable":true}},"required":["name"]},"Model113":{"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"]},"Model114":{"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/Model113"}},"Model115":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model116":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model117":{"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/Model114"},"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/Model115"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model116"},"triggerIncident":{"$ref":"#/components/schemas/TriggerIncident"},"runParallel":{"type":"boolean","description":"When true, the check will run in parallel in all selected locations.","default":false},"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/Model117"},"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"}}},"Model118":{"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"]},"Model119":{"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/Model119"}},"stats":{"type":"object","properties":{"last24Hours":{"$ref":"#/components/schemas/Model118"},"last7Days":{"$ref":"#/components/schemas/Model118"}}},"Model120":{"type":"object","properties":{"events":{"$ref":"#/components/schemas/events"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model121":{"type":"array","items":{"$ref":"#/components/schemas/Model120"}},"Model122":{"type":"object","properties":{"event":{"$ref":"#/components/schemas/Model119"},"stats":{"$ref":"#/components/schemas/stats"}}},"Model123":{"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"]},"Model124":{"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/Model123"}},"Model125":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model126":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"IcmpMonitorAssertionSource":{"type":"string","enum":["LATENCY","JSON_ANSWER"]},"IcmpMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","GREATER_THAN","LESS_THAN"]},"Model127":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/IcmpMonitorAssertionSource"},"comparison":{"$ref":"#/components/schemas/IcmpMonitorAssertionComparison"},"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/Model127"}},"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/ipFamily"},"pingCount":{"type":"integer","default":10,"minimum":1,"maximum":10},"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/Model124"},"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/Model125"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model126"},"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},"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":"integer","description":"The packet loss percentage threshold for degraded state.","default":10,"minimum":0,"maximum":100},"maxPacketLossThreshold":{"type":"integer","description":"The packet loss percentage threshold for failed state.","default":20,"minimum":0,"maximum":100}},"required":["name","request","heartbeat","script"]},"Model128":{"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"]},"Model129":{"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/Model128"}},"Model130":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model131":{"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/Model129"},"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/Model130"},"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},"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},"request":{"$ref":"#/components/schemas/IcmpMonitorRequest"},"checkType":{"$ref":"#/components/schemas/Model131"}},"required":["name"]},"Model132":{"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"]},"Model133":{"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/Model132"}},"Model134":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model135":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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/Model133"},"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/Model134"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model135"},"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},"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":"integer","description":"The packet loss percentage threshold for degraded state.","default":10,"minimum":0,"maximum":100},"maxPacketLossThreshold":{"type":"integer","description":"The packet loss percentage threshold for failed state.","default":20,"minimum":0,"maximum":100},"privateLocations":{"type":"string"}},"required":["heartbeat","script"]},"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":["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/Model31"}},"Model140":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model141":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model142":{"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/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},"checkType":{"$ref":"#/components/schemas/Model140"},"environmentVariables":{"$ref":"#/components/schemas/Model141"},"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/Model142"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}},"required":["name","script"]},"Model143":{"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"]},"Model144":{"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/Model143"}},"Model145":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model146":{"type":"string","enum":["MULTI_STEP"]},"Model147":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","nullable":true,"maxItems":50,"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/Model144"},"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/Model145"},"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},"checkType":{"$ref":"#/components/schemas/Model146"},"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/Model147"}},"required":["name","script"]},"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":["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/Model31"}},"Model152":{"type":"string","default":"MULTI_STEP","enum":["MULTI_STEP"]},"Model153":{"type":"array","description":"Key/value pairs for setting environment variables during check execution. Use global environment variables whenever possible.","example":[],"nullable":true,"maxItems":50,"items":{"$ref":"#/components/schemas/EnvironmentVariable"}},"Model154":{"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/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},"checkType":{"$ref":"#/components/schemas/Model152"},"environmentVariables":{"$ref":"#/components/schemas/Model153"},"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/Model154"},"dependencies":{"$ref":"#/components/schemas/CheckDependencyList"}}},"Model155":{"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"]},"Model156":{"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/Model155"}},"Model157":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model158":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model159":{"type":"string","enum":["RESPONSE_DATA","RESPONSE_TIME"]},"TcpCheckAssertion":{"type":"object","properties":{"source":{"$ref":"#/components/schemas/Model159"},"comparison":{"type":"string"},"property":{"type":"string","default":""},"target":{"type":"string","default":""},"regex":{"type":"string","default":"","nullable":true}}},"Model160":{"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"}},"Model161":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model160"},"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/Model156"},"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/Model157"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model158"},"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},"request":{"$ref":"#/components/schemas/Model161"},"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"]},"Model162":{"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"]},"Model163":{"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/Model162"}},"Model164":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model165":{"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"}},"Model166":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model165"},"ipFamily":{"$ref":"#/components/schemas/ipFamily"}},"required":["port"]},"Model167":{"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/Model163"},"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/Model164"},"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},"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/Model166"},"checkType":{"$ref":"#/components/schemas/Model167"}},"required":["name"]},"Model168":{"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"]},"Model169":{"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/Model168"}},"Model170":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model171":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model172":{"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"}},"Model173":{"type":"object","properties":{"hostname":{"type":"string","maxLength":2048},"port":{"type":"number"},"data":{"type":"string","default":null,"nullable":true},"assertions":{"$ref":"#/components/schemas/Model172"},"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/Model169"},"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/Model170"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model171"},"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},"request":{"$ref":"#/components/schemas/Model173"},"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"}}},"Model174":{"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"]},"Model175":{"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/Model174"}},"Model176":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model177":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model178":{"type":"string","default":"GET","enum":["GET"]},"UlrMonitorAssertionSource":{"type":"string","enum":["STATUS_CODE"]},"UrlMonitorAssertionComparison":{"type":"string","enum":["EQUALS","NOT_EQUALS","LESS_THAN","GREATER_THAN"]},"Model179":{"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/Model179"}},"UrlMonitorRequest":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model178"},"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"]},"Model180":{"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/Model175"},"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/Model176"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model177"},"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},"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"]},"Model181":{"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"]},"Model182":{"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/Model181"}},"Model183":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model184":{"type":"string","default":"GET","enum":["GET"]},"Model185":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model184"},"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"]},"Model186":{"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/Model182"},"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/Model183"},"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},"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/Model185"},"checkType":{"$ref":"#/components/schemas/Model186"}},"required":["name"]},"Model187":{"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"]},"Model188":{"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/Model187"}},"Model189":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model190":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model191":{"type":"string","default":"GET","enum":["GET"]},"Model192":{"type":"object","description":"Determines the request that the check is going to run.","properties":{"method":{"$ref":"#/components/schemas/Model191"},"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/Model188"},"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/Model189"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model190"},"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},"request":{"$ref":"#/components/schemas/Model192"},"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"}}},"Model193":{"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"]},"Model194":{"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/Model193"}},"Model195":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute this check.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model196":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"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/Model194"},"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/Model195"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model196"},"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},"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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"]},"Model197":{"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},"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},"link":{"type":"string","description":"A URL link to redirect when dashboard logo is clicked on.","example":"https://www.mycompany.com/","nullable":true},"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},"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"}}},"Model198":{"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"}},"required":["id","checkId","errorHash","rawErrorMessage","cleanedErrorMessage","firstSeen","lastSeen","archivedUntilNextEvent"]},"ErrorGroupsList":{"type":"array","items":{"$ref":"#/components/schemas/Model198"}},"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"}},"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"]},"Model199":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model200":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model199"},"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/Model200"}},"Model201":{"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"]},"Model202":{"type":"string","description":"The incident update status. Must be one of INVESTIGATING,IDENTIFIED,MONITORING,RESOLVED,MAINTENANCE","example":"INVESTIGATING","enum":["INVESTIGATING","IDENTIFIED","MONITORING","RESOLVED","MAINTENANCE"]},"Model203":{"type":"object","properties":{"status":{"$ref":"#/components/schemas/Model202"},"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"]},"Model204":{"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/Model203"}},"Model205":{"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/Model204"}},"required":["name","impact","dashboardId","id","created_at","updated_at","incidentUpdates"]},"Model206":{"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"]},"Model207":{"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/Model203"}},"Model208":{"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"]},"Location":{"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/Location"}},"MaintenanceWindowTagList":{"type":"array","description":"The names of the checks and groups maintenance window should apply to.","example":["production"],"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"},"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},"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"},"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}},"required":["name","startsAt","endsAt","repeatUnit"]},"CheckAssignment":{"type":"object","properties":{"id":{"type":"string","example":"4295d566-18bd-47ef-b22b-129a64ffd589","x-format":{"guid":true}},"checkId":{"type":"string","description":"The ID of the check.","example":"25039e6d-8631-4ee8-950a-bf7c893c3c1c","x-format":{"guid":true}},"privateLocationId":{"type":"string","description":"The ID of the assigned private location.","example":"cc3f943d-7a99-49f4-94aa-bddbaaad6eb0","x-format":{"guid":true}}},"required":["id","checkId","privateLocationId"]},"checkAssignments":{"type":"array","description":"The check this private location has assigned.","items":{"$ref":"#/components/schemas/CheckAssignment"}},"GroupAssignment":{"type":"object","properties":{"id":{"type":"string","example":"450d2f06-2300-46ed-8982-b63cd53fc494","x-format":{"guid":true}},"groupId":{"type":"number","description":"The ID of the group.","example":10},"privateLocationId":{"type":"string","description":"The ID of the assigned private location.","example":"895c13cc-7de2-46df-9985-cb01b995a3cf","x-format":{"guid":true}}},"required":["id","groupId","privateLocationId"]},"groupAssignments":{"type":"array","description":"The group this private location has assigned.","items":{"$ref":"#/components/schemas/GroupAssignment"}},"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"]},"Model209":{"type":"array","items":{"$ref":"#/components/schemas/privateLocationKeys"}},"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},"checkAssignments":{"$ref":"#/components/schemas/checkAssignments"},"groupAssignments":{"$ref":"#/components/schemas/groupAssignments"},"keys":{"$ref":"#/components/schemas/Model209"},"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}},"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"]},"Model210":{"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},"checkAssignments":{"$ref":"#/components/schemas/checkAssignments"},"groupAssignments":{"$ref":"#/components/schemas/groupAssignments"},"keys":{"$ref":"#/components/schemas/Model210"},"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"}},"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.51.1","@axe-core/playwright":"4.10.1","@azure/identity":"4.9.1","@azure/keyvault-secrets":"4.9.0","@checkly/playwright-helpers":"1.0.3","@faker-js/faker":"9.7.0","@google-cloud/local-auth":"3.0.1","@opentelemetry/api":"1.9.0","@opentelemetry/exporter-metrics-otlp-grpc":"0.53.0","@opentelemetry/sdk-metrics":"1.26.0","@opentelemetry/sdk-trace-base":"1.26.0","@t3-oss/env-nextjs":"0.11.1","@xmldom/xmldom":"0.9.2","aws4":"1.13.2","axios":"0.28.0","btoa":"1.2.1","http":"22.11.0","https":"22.11.0","crypto-js":"4.2.0","date-fns":"3.3.1","date-fns-tz":"3.1.3","dotenv":"16.4.5","ethers":"6.13.2","expect":"29.7.0","form-data":"4.0.4","gmail-api-parse-message-ts":"2.2.33","google-auth-library":"9.14.1","googleapis":"144.0.0","graphql":"16.9.0","graphql-tag":"2.12.6","jose":"5.9.2","jsdom":"25.0.0","jsonwebtoken":"9.0.2","lodash":"4.17.21","long":"5.2.3","moment":"2.30.1","nice-grpc":"2.1.12","nice-grpc-client-middleware-deadline":"2.0.15","nice-grpc-client-middleware-devtools":"1.0.7","nice-grpc-client-middleware-retry":"3.1.11","nice-grpc-common":"2.0.2","nice-grpc-error-details":"0.2.9","nice-grpc-opentelemetry":"0.1.18","nice-grpc-prometheus":"0.2.7","nice-grpc-server-health":"2.0.14","nice-grpc-server-middleware-terminator":"2.0.14","nice-grpc-server-reflection":"2.0.14","nice-grpc-web":"3.3.7","node-pop3":"0.9.1","otpauth":"9.4.0","playwright":"1.51.1","pdf2json":"3.1.4","prisma":"6.6.0","protobufjs":"7.5.0","tedious":"18.6.1","twilio":"5.3.0","uuid":"11.1.0","ws":"8.18.1","xml-crypto":"6.1.1","xml-encryption":"3.1.0","zod":"3.24.3","@clerk/testing":"1.5.1","mailosaur":"8.6.1","gaxios":"6.7.1","@kubernetes/client-node":"1.1.2","mysql":"2.18.1"}},"Runtime":{"type":"object","properties":{"name":{"type":"string","description":"The unique name of this runtime.","example":"2025.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.51.1"},"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-01-19T19:41:51.903Z"},"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"},"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"}},"StatusPageV2":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"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"}},"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"}},"StatusPageV2Update":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2CardUpdates"}},"required":["name","url","cards"]},"StatusPageV2WithId":{"type":"object","properties":{"name":{"type":"string"},"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},"redirectTo":{"type":"string","nullable":true,"x-format":{"uri":true}},"favicon":{"type":"string","nullable":true},"defaultTheme":{"$ref":"#/components/schemas/defaultTheme"},"cards":{"$ref":"#/components/schemas/StatusPageV2Cards"},"id":{"type":"string","x-format":{"guid":true}},"whiteLabel":{"type":"boolean"}},"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"},"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-01-19T19:41:51.961Z"},"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"},"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"}},"required":["name","severity","services"]},"Model211":{"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"]},"Model212":{"type":"string","description":"The type of subscription.","enum":["EMAIL"]},"Model213":{"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/Model212"},"address":{"type":"string","description":"The email address to subscribe to the status page.","x-format":{"email":true}},"status":{"$ref":"#/components/schemas/Model213"},"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"}},"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"]},"Model214":{"type":"array","items":{"$ref":"#/components/schemas/EnvironmentVariableGet"}},"Model215":{"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"]},"Model216":{"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/Model215"}},"Model217":{"type":"string","description":"The runtime version, i.e. fixed set of runtime dependencies, used to execute checks in this group.","default":null,"enum":["2025.04","2024.09","2024.02","2023.09","2023.02","2022.10"],"nullable":true},"Model218":{"type":"array","description":"List of alert channel subscriptions.","example":[],"items":{"$ref":"#/components/schemas/Model31"}},"Model219":{"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"]},"Model220":{"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]}}},"Model221":{"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]}}},"Model222":{"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":[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/Model220"},"timeBasedEscalation":{"$ref":"#/components/schemas/Model221"},"reminders":{"$ref":"#/components/schemas/Model222"},"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/Model216"},"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/Model217"},"environmentVariables":{"$ref":"#/components/schemas/environmentVariables"},"alertChannelSubscriptions":{"$ref":"#/components/schemas/Model218"},"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/Model219"},"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"]}}},"tags":[],"paths":{"/accounts/{accountId}/ai/agents/stream":{"post":{"operationId":"postAccountsAccountidAiAgentsStream","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model2"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/accounts/{accountId}/metrics":{"post":{"operationId":"postAccountsAccountidMetrics","parameters":[{"name":"accountId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["opentelemetry","metrics"],"requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model3"}}}},"responses":{"default":{"description":"Successful","content":{"application/json":{"schema":{"type":"string"}}}}}}},"/v1/accounts":{"get":{"summary":"[beta] Fetch user accounts","operationId":"getV1Accounts","description":"**[beta]** List account details based on supplied API key. (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/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":"[beta] Fetch current account details","operationId":"getV1AccountsMe","description":"**[beta]** Get details from the current account (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/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/{accountId}":{"get":{"summary":"[beta] Fetch a given account details","operationId":"getV1AccountsAccountid","description":"**[beta]** Get details from a specific account. (This endpoint is in beta and may change without notice.)","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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/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.
-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":"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":"alertChannelId","in":"query","schema":{"type":"integer","description":"Limit results to an alert channel","x-constraint":{"sign":"positive"}},"description":"Limit results to an alert channel"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Sending the alert notification was unsuccessful"},"description":"Sending the alert notification was unsuccessful"}],"tags":["Alert notifications"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertNotificationList"}}}},"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/analytics/api-checks/{id}":{"get":{"summary":"API checks","operationId":"getV1AnalyticsApichecksId","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 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":"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":"alertChannelId","in":"query","schema":{"type":"integer","description":"Limit results to an alert channel","x-constraint":{"sign":"positive"}},"description":"Limit results to an alert channel"},{"name":"hasFailures","in":"query","schema":{"type":"boolean","description":"Sending the alert notification was unsuccessful"},"description":"Sending the alert notification was unsuccessful"}],"tags":["Alert notifications"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AlertNotificationList"}}}},"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/analytics/api-checks/{id}":{"get":{"summary":"API checks","operationId":"getV1AnalyticsApichecksId","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/Model10"}}}},"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/browser-checks/{id}":{"get":{"summary":"Browser checks","operationId":"getV1AnalyticsBrowserchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Browser Check metrics across custom time ranges. For example, you can get the average amount of console errors, the p99 of your FCP and the standard deviation of your TTFB for the second page in your Browser check with one API call.
+**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/Model10"}}}},"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/browser-checks/{id}":{"get":{"summary":"Browser checks","operationId":"getV1AnalyticsBrowserchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Browser Check metrics across custom time ranges. For example, you can get the average amount of console errors, the p99 of your FCP and the standard deviation of your TTFB for the second page in your Browser check with one API call.
-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","pageIndex"]},"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 Browser Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","TTFB","FCP","LCP","CLS","TBT","consoleErrors","networkErrors","userScriptErrors","documentErrors","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","TTFB_avg","TTFB_max","TTFB_median","TTFB_min","TTFB_p50","TTFB_p90","TTFB_p95","TTFB_p99","TTFB_stddev","TTFB_sum","FCP_avg","FCP_max","FCP_median","FCP_min","FCP_p50","FCP_p90","FCP_p95","FCP_p99","FCP_stddev","FCP_sum","LCP_avg","LCP_max","LCP_median","LCP_min","LCP_p50","LCP_p90","LCP_p95","LCP_p99","LCP_stddev","LCP_sum","CLS_avg","CLS_max","CLS_median","CLS_min","CLS_p50","CLS_p90","CLS_p95","CLS_p99","CLS_stddev","CLS_sum","TBT_avg","TBT_max","TBT_median","TBT_min","TBT_p50","TBT_p90","TBT_p95","TBT_p99","TBT_stddev","TBT_sum","consoleErrors_avg","consoleErrors_max","consoleErrors_median","consoleErrors_min","consoleErrors_p50","consoleErrors_p90","consoleErrors_p95","consoleErrors_p99","consoleErrors_stddev","consoleErrors_sum","networkErrors_avg","networkErrors_max","networkErrors_median","networkErrors_min","networkErrors_p50","networkErrors_p90","networkErrors_p95","networkErrors_p99","networkErrors_stddev","networkErrors_sum","userScriptErrors_avg","userScriptErrors_max","userScriptErrors_median","userScriptErrors_min","userScriptErrors_p50","userScriptErrors_p90","userScriptErrors_p95","userScriptErrors_p99","userScriptErrors_stddev","userScriptErrors_sum","documentErrors_avg","documentErrors_max","documentErrors_median","documentErrors_min","documentErrors_p50","documentErrors_p90","documentErrors_p95","documentErrors_p99","documentErrors_stddev","documentErrors_sum"]}},"description":"Available metrics for Browser 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/Model13"}}}},"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/heartbeat-checks/{id}":{"get":{"summary":"Heartbeat checks","operationId":"getV1AnalyticsHeartbeatchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Heartbeat Check metrics across custom time ranges. Rate-limiting is applied to this endpoint, you can send 600 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 heartbeat request was late, early, etc.","example":["FAILING"],"x-constraint":{"single":true},"items":{"type":"string","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]}},"description":"Filter based on whether a heartbeat request was late, early, etc.","style":"form","explode":true},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for Heartbeat Checks. You can pass multiple metrics as a comma separated string.","default":["availability"],"x-constraint":{"single":true},"items":{"type":"string","enum":["availability","retries"]}},"description":"Available metrics for Heartbeat 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/Model16"}}}},"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/metrics":{"get":{"summary":"List all available reporting metrics.","operationId":"getV1AnalyticsMetrics","description":"List all available reporting metrics.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkType","in":"query","schema":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"required":true}],"tags":["Analytics"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model17"}}}},"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/multistep-checks/{id}":{"get":{"summary":"Multistep checks","operationId":"getV1AnalyticsMultistepchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Multistep Check metrics across custom time ranges. 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 Multistep Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum"]}},"description":"Available metrics for Multistep 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/Model20"}}}},"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/playwright-checks/{id}":{"get":{"summary":"Playwright checks","operationId":"getV1AnalyticsPlaywrightchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Playwright Check metrics across custom time ranges. 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 Playwright Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum"]}},"description":"Available metrics for Playwright 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/Model23"}}}},"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/tcp-checks/{id}":{"get":{"summary":"TCP checks","operationId":"getV1AnalyticsTcpchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated TCP Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the check phases of your TCP 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","pageIndex"]},"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 Browser Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","TTFB","FCP","LCP","CLS","TBT","consoleErrors","networkErrors","userScriptErrors","documentErrors","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum","TTFB_avg","TTFB_max","TTFB_median","TTFB_min","TTFB_p50","TTFB_p90","TTFB_p95","TTFB_p99","TTFB_stddev","TTFB_sum","FCP_avg","FCP_max","FCP_median","FCP_min","FCP_p50","FCP_p90","FCP_p95","FCP_p99","FCP_stddev","FCP_sum","LCP_avg","LCP_max","LCP_median","LCP_min","LCP_p50","LCP_p90","LCP_p95","LCP_p99","LCP_stddev","LCP_sum","CLS_avg","CLS_max","CLS_median","CLS_min","CLS_p50","CLS_p90","CLS_p95","CLS_p99","CLS_stddev","CLS_sum","TBT_avg","TBT_max","TBT_median","TBT_min","TBT_p50","TBT_p90","TBT_p95","TBT_p99","TBT_stddev","TBT_sum","consoleErrors_avg","consoleErrors_max","consoleErrors_median","consoleErrors_min","consoleErrors_p50","consoleErrors_p90","consoleErrors_p95","consoleErrors_p99","consoleErrors_stddev","consoleErrors_sum","networkErrors_avg","networkErrors_max","networkErrors_median","networkErrors_min","networkErrors_p50","networkErrors_p90","networkErrors_p95","networkErrors_p99","networkErrors_stddev","networkErrors_sum","userScriptErrors_avg","userScriptErrors_max","userScriptErrors_median","userScriptErrors_min","userScriptErrors_p50","userScriptErrors_p90","userScriptErrors_p95","userScriptErrors_p99","userScriptErrors_stddev","userScriptErrors_sum","documentErrors_avg","documentErrors_max","documentErrors_median","documentErrors_min","documentErrors_p50","documentErrors_p90","documentErrors_p95","documentErrors_p99","documentErrors_stddev","documentErrors_sum"]}},"description":"Available metrics for Browser 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/Model13"}}}},"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/heartbeat-checks/{id}":{"get":{"summary":"Heartbeat checks","operationId":"getV1AnalyticsHeartbeatchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Heartbeat Check metrics across custom time ranges. **Rate-limiting is applied to this endpoint, you can send 600 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 heartbeat request was late, early, etc.","example":["FAILING"],"x-constraint":{"single":true},"items":{"type":"string","enum":["FAILING","EARLY","RECEIVED","GRACE","LATE"]}},"description":"Filter based on whether a heartbeat request was late, early, etc.","style":"form","explode":true},{"name":"metrics","in":"query","schema":{"type":"array","description":"Available metrics for Heartbeat Checks. You can pass multiple metrics as a comma separated string.","default":["availability"],"x-constraint":{"single":true},"items":{"type":"string","enum":["availability","retries"]}},"description":"Available metrics for Heartbeat 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/Model16"}}}},"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/metrics":{"get":{"summary":"List all available reporting metrics.","operationId":"getV1AnalyticsMetrics","description":"List all available reporting metrics.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general","x-format":{"guid":true}},"description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/account/general"},{"name":"checkType","in":"query","schema":{"type":"string","enum":["API","BROWSER","HEARTBEAT","ICMP","MULTI_STEP","TCP","PLAYWRIGHT","URL","DNS"]},"required":true}],"tags":["Analytics"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model17"}}}},"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/multistep-checks/{id}":{"get":{"summary":"Multistep checks","operationId":"getV1AnalyticsMultistepchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Multistep Check metrics across custom time ranges. **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 Multistep Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum"]}},"description":"Available metrics for Multistep 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/Model20"}}}},"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/playwright-checks/{id}":{"get":{"summary":"Playwright checks","operationId":"getV1AnalyticsPlaywrightchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated Playwright Check metrics across custom time ranges. **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 Playwright Checks. You can pass multiple metrics as a comma separated string.","x-constraint":{"single":true},"items":{"type":"string","enum":["responseTime","availability","retries","responseTime_avg","responseTime_max","responseTime_median","responseTime_min","responseTime_p50","responseTime_p90","responseTime_p95","responseTime_p99","responseTime_stddev","responseTime_sum"]}},"description":"Available metrics for Playwright 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/Model23"}}}},"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/tcp-checks/{id}":{"get":{"summary":"TCP checks","operationId":"getV1AnalyticsTcpchecksId","description":"Fetch detailed availability metrics and aggregated or non-aggregated TCP Check metrics across custom time ranges. For example, you can get the p99 and p95 of all the check phases of your TCP 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"]},"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/Model26"}}}},"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"]},"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/Model26"}}}},"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/Model28"}}}},"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-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/Model28"}}}},"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-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.
-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":"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\"."}],"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-groups":{"get":{"summary":"List all check groups","operationId":"getV1Checkgroups","description":"Lists all current check groups in your account. The \"checks\" property is an array of check UUID's for convenient referencing. It is read only and you cannot use it to add checks to a 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":"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":"tag","in":"query","schema":{"type":"array","description":"Filters check groups by tags. Returns check groups that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters check groups by tags. Returns check groups that have at least one of the specified tags.","style":"form","explode":true},{"name":"name","in":"query","schema":{"type":"array","description":"Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names.","style":"form","explode":true}],"tags":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupList"}}}},"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 group","operationId":"postV1Checkgroups","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/CheckGroupCreate"}}}},"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"}}}}},"deprecated":true}},"/v1/check-groups/{groupId}/checks/{checkId}":{"get":{"summary":"Retrieve one check in a specific group with group settings applied","operationId":"getV1CheckgroupsGroupidChecksCheckid","description":"Show details of one check in a specific check group with the group settings applied.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCheck"}}}},"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-groups/{id}":{"delete":{"summary":"Delete a check group.","operationId":"deleteV1CheckgroupsId","description":"Permanently removes a check group. You cannot delete a check group if it still contains 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":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Check groups"],"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"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check group","operationId":"getV1CheckgroupsId","description":"Show details of a specific 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}],"tags":["Check groups"],"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"}}}}}},"put":{"summary":"Update a check group","operationId":"putV1CheckgroupsId","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/CheckGroupUpdate"}}}},"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"}}}}},"deprecated":true}},"/v1/check-groups/{id}/checks":{"get":{"summary":"Retrieve all checks in a specific group with group settings applied","operationId":"getV1CheckgroupsIdChecks","description":"Lists all checks in a specific check group with the group settings applied.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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":"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":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model43"}}}},"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-results/{checkId}":{"get":{"summary":"Lists all check results","operationId":"getV1CheckresultsCheckid","description":"[DEPRECATED] This endpoint will be removed soon. Please use the `GET /v2/check-results/{checkId}` endpoint instead.
+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":"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\"."}],"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-groups":{"get":{"summary":"List all check groups","operationId":"getV1Checkgroups","description":"Lists all current check groups in your account. The \"checks\" property is an array of check UUID's for convenient referencing. It is read only and you cannot use it to add checks to a 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":"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":"tag","in":"query","schema":{"type":"array","description":"Filters check groups by tags. Returns check groups that have at least one of the specified tags.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters check groups by tags. Returns check groups that have at least one of the specified tags.","style":"form","explode":true},{"name":"name","in":"query","schema":{"type":"array","description":"Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names.","x-constraint":{"single":true},"items":{"type":"string"}},"description":"Filters check groups by exact name match. Accepts one or more names and returns groups that match any of the specified names.","style":"form","explode":true}],"tags":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupList"}}}},"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 group","operationId":"postV1Checkgroups","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/CheckGroupCreate"}}}},"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"}}}}},"deprecated":true}},"/v1/check-groups/{groupId}/checks/{checkId}":{"get":{"summary":"Retrieve one check in a specific group with group settings applied","operationId":"getV1CheckgroupsGroupidChecksCheckid","description":"Show details of one check in a specific check group with the group settings applied.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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},{"name":"checkId","in":"path","schema":{"type":"string","x-format":{"guid":true}},"required":true}],"tags":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CheckGroupCheck"}}}},"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-groups/{id}":{"delete":{"summary":"Delete a check group.","operationId":"deleteV1CheckgroupsId","description":"Permanently removes a check group. You cannot delete a check group if it still contains 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":"id","in":"path","schema":{"type":"integer","x-constraint":{"sign":"positive"}},"required":true}],"tags":["Check groups"],"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"}}}},"409":{"description":"Conflict","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ConflictError"}}}},"429":{"description":"Too Many Requests","content":{"application/json":{"schema":{"$ref":"#/components/schemas/TooManyRequestsError"}}}}}},"get":{"summary":"Retrieve a check group","operationId":"getV1CheckgroupsId","description":"Show details of a specific 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}],"tags":["Check groups"],"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"}}}}}},"put":{"summary":"Update a check group","operationId":"putV1CheckgroupsId","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/CheckGroupUpdate"}}}},"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"}}}}},"deprecated":true}},"/v1/check-groups/{id}/checks":{"get":{"summary":"Retrieve all checks in a specific group with group settings applied","operationId":"getV1CheckgroupsIdChecks","description":"Lists all checks in a specific check group with the group settings applied.","parameters":[{"name":"x-checkly-account","in":"header","schema":{"type":"string","description":"Your Checkly account ID, you can find it at https://app.checklyhq.com/settings/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":"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":["Check groups"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model43"}}}},"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-results/{checkId}":{"get":{"summary":"Lists all check results","operationId":"getV1CheckresultsCheckid","description":"**[DEPRECATED] This endpoint will be removed soon. Please use the `GET /v2/check-results/{checkId}` endpoint instead.**
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.
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":["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":"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/CheckURLCreate"}}}},"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-01-16T02:37:25.878Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-01-17T02:37:25.879Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model118"}}}},"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-01-16T02:37:25.880Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-01-17T02:37:25.880Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model121"}}}},"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/Model122"}}}},"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/Model180"}}}},"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":["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":"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/CheckURLCreate"}}}},"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-01-18T19:41:51.194Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-01-19T19:41:51.194Z"}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model118"}}}},"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-01-18T19:41:51.196Z"}},{"name":"endTime","in":"query","schema":{"type":"string","format":"date","default":"2026-01-19T19:41:51.196Z"}},{"name":"limit","in":"query","schema":{"type":"number","default":10,"maximum":10}}],"tags":["Heartbeats"],"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model121"}}}},"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/Model122"}}}},"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/Model180"}}}},"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/Model197"}}}},"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/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}],"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/Model201"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model205"}}}},"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/Model205"}}}},"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/Model206"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model207"}}}},"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/Model200"}}}},"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/Model208"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model203"}}}},"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"}],"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 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/Model197"}}}},"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/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}],"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/Model201"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model205"}}}},"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/Model205"}}}},"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/Model206"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model207"}}}},"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/Model200"}}}},"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/Model208"}}}},"responses":{"200":{"description":"Successful","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Model203"}}}},"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"}],"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/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/StatusPageV2Update"}}}},"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/Model211"}}}},"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/StatusPageV2Update"}}}},"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/{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/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/Model214"}}}},"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/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/StatusPageV2Update"}}}},"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/Model211"}}}},"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/StatusPageV2Update"}}}},"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/{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/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/Model214"}}}},"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":["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"}}}}}}}},"x-alt-definitions":{"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":["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"}}}}}}}},"x-alt-definitions":{"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
diff --git a/api-reference/opentelemetry/post-accounts-metrics.mdx b/api-reference/opentelemetry/post-accounts-metrics.mdx
index 74b81794..c858501a 100644
--- a/api-reference/opentelemetry/post-accounts-metrics.mdx
+++ b/api-reference/opentelemetry/post-accounts-metrics.mdx
@@ -1,3 +1,4 @@
---
openapi: post /accounts/{accountId}/metrics
+title: Post metrics for an account
---
\ No newline at end of file
diff --git a/api-reference/runtimes/lists-all-supported-runtimes.mdx b/api-reference/runtimes/lists-all-supported-runtimes.mdx
index 93d67846..b1a2ebf5 100644
--- a/api-reference/runtimes/lists-all-supported-runtimes.mdx
+++ b/api-reference/runtimes/lists-all-supported-runtimes.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/runtimes
+title: List all supported runtimes
---
\ No newline at end of file
diff --git a/api-reference/runtimes/shows-details-for-one-specific-runtime.mdx b/api-reference/runtimes/shows-details-for-one-specific-runtime.mdx
index 24803e6a..917a8b68 100644
--- a/api-reference/runtimes/shows-details-for-one-specific-runtime.mdx
+++ b/api-reference/runtimes/shows-details-for-one-specific-runtime.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/runtimes/{id}
+title: List details for a runtime
---
\ No newline at end of file
diff --git a/api-reference/snippets/create-a-snippet.mdx b/api-reference/snippets/create-a-snippet.mdx
new file mode 100644
index 00000000..2ec0d520
--- /dev/null
+++ b/api-reference/snippets/create-a-snippet.mdx
@@ -0,0 +1,4 @@
+---
+openapi: post /v1/snippets
+title: Create a snippet
+---
\ No newline at end of file
diff --git a/api-reference/snippets/delete-snippet.mdx b/api-reference/snippets/delete-snippet.mdx
new file mode 100644
index 00000000..bcacc892
--- /dev/null
+++ b/api-reference/snippets/delete-snippet.mdx
@@ -0,0 +1,4 @@
+---
+openapi: delete /v1/snippets/{id}
+title: Delete a snippet
+---
\ No newline at end of file
diff --git a/api-reference/snippets/list-all-snippets.mdx b/api-reference/snippets/list-all-snippets.mdx
new file mode 100644
index 00000000..79fe8c74
--- /dev/null
+++ b/api-reference/snippets/list-all-snippets.mdx
@@ -0,0 +1,4 @@
+---
+openapi: get /v1/snippets
+title: List all snippets
+---
\ No newline at end of file
diff --git a/api-reference/snippets/list-specific-snippet.mdx b/api-reference/snippets/list-specific-snippet.mdx
new file mode 100644
index 00000000..ddf8d5aa
--- /dev/null
+++ b/api-reference/snippets/list-specific-snippet.mdx
@@ -0,0 +1,4 @@
+---
+openapi: get /v1/snippets/{id}
+title: Retrieve a snippet
+---
\ No newline at end of file
diff --git a/api-reference/snippets/update-snippet.mdx b/api-reference/snippets/update-snippet.mdx
new file mode 100644
index 00000000..5b8bc17c
--- /dev/null
+++ b/api-reference/snippets/update-snippet.mdx
@@ -0,0 +1,4 @@
+---
+openapi: put /v1/snippets/{id}
+title: Update a snippet
+---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ips-for-check-runs-1.mdx b/api-reference/static-ips/lists-all-source-ips-for-check-runs-1.mdx
index 1a50669d..1a3fd38b 100644
--- a/api-reference/static-ips/lists-all-source-ips-for-check-runs-1.mdx
+++ b/api-reference/static-ips/lists-all-source-ips-for-check-runs-1.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ips-by-region
+title: List IPs for check runs by region
---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file.mdx b/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file.mdx
index ecee4e56..0e1fc9fd 100644
--- a/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file.mdx
+++ b/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ips.txt
+title: List IPs for check runs as a TXT file
---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ips-for-check-runs.mdx b/api-reference/static-ips/lists-all-source-ips-for-check-runs.mdx
index 7160c0af..9e61f11a 100644
--- a/api-reference/static-ips/lists-all-source-ips-for-check-runs.mdx
+++ b/api-reference/static-ips/lists-all-source-ips-for-check-runs.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ips
+title: List IPs for check runs
---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1.mdx b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1.mdx
index 8174fe0b..fa5f7493 100644
--- a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1.mdx
+++ b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ipv6s-by-region
+title: List IPv6s for check runs by region
---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file.mdx b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file.mdx
index ae4abe76..079acb3a 100644
--- a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file.mdx
+++ b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ipv6s.txt
+title: List IPv6s for check runs as a TXT file
---
\ No newline at end of file
diff --git a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs.mdx b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs.mdx
index 5d3521d3..03380901 100644
--- a/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs.mdx
+++ b/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs.mdx
@@ -1,3 +1,4 @@
---
openapi: get /v1/static-ipv6s
+title: List IPv6s for check runs
---
\ No newline at end of file
diff --git a/docs.json b/docs.json
index 632083e5..0fc03e15 100644
--- a/docs.json
+++ b/docs.json
@@ -576,296 +576,352 @@
},
{
"tab": "API",
- "openapi": "api-reference/openapi.json",
"groups": [
+
{
- "group": "opentelemetry",
+ "group": "PLATFORM",
"pages": [
-
- ]
- },
- {
- "group": "Accounts",
- "pages": [
- "api-reference/accounts/fetch-user-accounts",
- "api-reference/accounts/fetch-current-account-details",
- "api-reference/accounts/fetch-a-given-account-details"
- ]
- },
- {
- "group": "Alert channels",
- "pages": [
- "api-reference/alert-channels/list-all-alert-channels",
- "api-reference/alert-channels/create-an-alert-channel",
- "api-reference/alert-channels/retrieve-an-alert-channel",
- "api-reference/alert-channels/update-an-alert-channel",
- "api-reference/alert-channels/delete-an-alert-channel",
- "api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel"
- ]
- },
- {
- "group": "Alert notifications",
- "pages": [
- "api-reference/alert-notifications/lists-all-alert-notifications"
- ]
- },
- {
- "group": "Analytics",
- "pages": [
- "api-reference/analytics/api-checks",
- "api-reference/analytics/browser-checks",
- "api-reference/analytics/heartbeat-checks",
- "api-reference/analytics/list-all-available-reporting-metrics",
- "api-reference/analytics/multistep-checks",
- "api-reference/analytics/playwright-checks",
- "api-reference/analytics/tcp-checks",
- "api-reference/analytics/url-monitors"
-
- ]
- },
- {
- "group": "Badges",
- "pages": [
- "api-reference/badges/get-v1badgeschecks",
- "api-reference/badges/get-v1badgesgroups"
- ]
- },
- {
- "group": "Check alerts",
- "pages": [
- "api-reference/check-alerts/list-all-alerts-for-your-account",
- "api-reference/check-alerts/list-alerts-for-a-specific-check"
- ]
- },
- {
- "group": "Check groups",
- "pages": [
- "api-reference/check-groups/list-all-check-groups",
- "api-reference/check-groups/create-a-check-group",
- "api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied",
- "api-reference/check-groups/retrieve-a-check-group",
- "api-reference/check-groups/update-a-check-group",
- "api-reference/check-groups/delete-a-check-group",
- "api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied",
- "api-reference/check-groups/create-a-check-group-v2",
- "api-reference/check-groups/update-a-check-group-v2"
- ]
- },
- {
- "group": "Check results",
- "pages": [
- "api-reference/check-results/lists-all-check-results",
- "api-reference/check-results/retrieve-a-check-result",
- "api-reference/check-results/lists-all-check-results-1"
- ]
- },
- {
- "group": "Check sessions",
- "pages": [
- "api-reference/check-sessions/trigger-a-new-check-session",
- "api-reference/check-sessions/retrieve-a-check-session",
- "api-reference/check-sessions/await-the-completion-of-a-check-session"
- ]
- },
- {
- "group": "Check status",
- "pages": [
- "api-reference/check-status/list-all-check-statuses",
- "api-reference/check-status/retrieve-check-status-details"
- ]
- },
- {
- "group": "Checks",
- "pages": [
- "api-reference/checks/list-all-checks",
- "api-reference/checks/create-a-check",
- "api-reference/checks/create-an-api-check",
- "api-reference/checks/update-an-api-check",
- "api-reference/checks/create-a-browser-check",
- "api-reference/checks/update-a-browser-check",
- "api-reference/checks/create-a-multi-step-check",
- "api-reference/checks/update-a-multi-step-check",
- "api-reference/checks/create-a-tcp-check",
- "api-reference/checks/update-an-tcp-check",
- "api-reference/checks/retrieve-a-check",
- "api-reference/checks/update-a-check",
- "api-reference/checks/delete-a-check"
- ]
- },
- {
- "group": "Heartbeats",
- "pages": [
- "api-reference/heartbeats/create-a-heartbeat-check",
- "api-reference/heartbeats/update-a-heartbeat-check",
- "api-reference/heartbeats/get-heartbeat-availability",
- "api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat",
- "api-reference/heartbeats/get-a-specific-heartbeat-event"
- ]
- },
- {
- "group": "Monitors",
- "pages": [
- "api-reference/monitors/create-a-url-monitor",
- "api-reference/monitors/update-an-url-monitor"
- ]
- },
- {
- "group": "Client certificates",
- "pages": [
- "api-reference/client-certificates/lists-all-client-certificates",
- "api-reference/client-certificates/creates-a-new-client-certificate",
- "api-reference/client-certificates/shows-one-client-certificate",
- "api-reference/client-certificates/deletes-a-client-certificate"
- ]
- },
- {
- "group": "Dashboards",
- "pages": [
- "api-reference/dashboards/list-all-dashboards",
- "api-reference/dashboards/create-a-dashboard",
- "api-reference/dashboards/retrieve-a-dashboard",
- "api-reference/dashboards/update-a-dashboard",
- "api-reference/dashboards/delete-a-dashboard"
- ]
- },
- {
- "group": "Incidents",
- "pages": [
- "api-reference/incidents/create-an-incident",
- "api-reference/incidents/retrieve-an-incident",
- "api-reference/incidents/update-an-incident",
- "api-reference/incidents/delete-an-incident"
- ]
- },
- {
- "group": "Incident Updates",
- "pages": [
- "api-reference/incident-updates/create-an-incident-update",
- "api-reference/incident-updates/update-an-incident-update",
- "api-reference/incident-updates/delete-an-incident-update"
- ]
- },
- {
- "group": "Location",
- "pages": [
- "api-reference/location/lists-all-supported-locations"
- ]
- },
- {
- "group": "Maintenance windows",
- "pages": [
- "api-reference/maintenance-windows/list-all-maintenance-windows",
- "api-reference/maintenance-windows/create-a-maintenance-window",
- "api-reference/maintenance-windows/retrieve-a-maintenance-window",
- "api-reference/maintenance-windows/update-a-maintenance-window",
- "api-reference/maintenance-windows/delete-a-maintenance-window"
- ]
- },
- {
- "group": "Private locations",
- "pages": [
- "api-reference/private-locations/list-all-private-locations",
- "api-reference/private-locations/create-a-private-location",
- "api-reference/private-locations/retrieve-a-private-location",
- "api-reference/private-locations/update-a-private-location",
- "api-reference/private-locations/remove-a-private-location",
- "api-reference/private-locations/generate-a-new-api-key-for-a-private-location",
- "api-reference/private-locations/remove-an-existing-api-key-for-a-private-location",
- "api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time"
- ]
- },
- {
- "group": "Reporting",
- "pages": [
- "api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups"
- ]
- },
- {
- "group": "Runtimes",
- "pages": [
- "api-reference/runtimes/lists-all-supported-runtimes",
- "api-reference/runtimes/shows-details-for-one-specific-runtime"
- ]
- },
- {
- "group": "Snippets",
- "pages": [
- "api-reference/snippets/list-all-snippets",
- "api-reference/snippets/create-a-snippet",
- "api-reference/snippets/retrieve-a-snippet",
- "api-reference/snippets/update-a-snippet",
- "api-reference/snippets/delete-a-snippet"
- ]
- },
- {
- "group": "Static IPs",
- "pages": [
- "api-reference/static-ips/lists-all-source-ips-for-check-runs",
- "api-reference/static-ips/lists-all-source-ips-for-check-runs-1",
- "api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file",
- "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs",
- "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1",
- "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file"
- ]
- },
- {
- "group": "Status Pages",
- "pages": [
- "api-reference/status-pages/retrieve-all-status-pages",
- "api-reference/status-pages/create-a-new-status-page",
- "api-reference/status-pages/retrieve-a-single-status-page-by-id",
- "api-reference/status-pages/update-an-existing-status-page",
- "api-reference/status-pages/delete-a-status-page",
- "api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page",
- "api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page"
+ {
+ "group": "Accounts",
+ "pages": [
+ "api-reference/accounts/fetch-user-accounts",
+ "api-reference/accounts/fetch-current-account-details",
+ "api-reference/accounts/fetch-a-given-account-details"
+ ]
+ },
+ {
+ "group": "Environment Variables",
+ "pages": [
+ "api-reference/environment-variables/list-all-environment-variables",
+ "api-reference/environment-variables/create-an-environment-variable",
+ "api-reference/environment-variables/retrieve-an-environment-variable",
+ "api-reference/environment-variables/update-an-environment-variable",
+ "api-reference/environment-variables/delete-an-environment-variable"
+ ]
+ },
+
+ {
+ "group": "Runtimes",
+ "pages": [
+ "api-reference/runtimes/lists-all-supported-runtimes",
+ "api-reference/runtimes/shows-details-for-one-specific-runtime"
+ ]
+ },
+ {
+ "group": "Snippets",
+ "pages": [
+ "api-reference/snippets/list-all-snippets",
+ "api-reference/snippets/create-a-snippet",
+ "api-reference/snippets/list-specific-snippet",
+ "api-reference/snippets/update-snippet",
+ "api-reference/snippets/delete-snippet"
+ ]
+ },
+ {
+ "group": "Static IPs",
+ "pages": [
+ "api-reference/static-ips/lists-all-source-ips-for-check-runs",
+ "api-reference/static-ips/lists-all-source-ips-for-check-runs-1",
+ "api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file",
+ "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs",
+ "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1",
+ "api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file"
+ ]
+ },
+ {
+ "group": "Badges",
+ "pages": [
+ "api-reference/badges/get-v1badgeschecks",
+ "api-reference/badges/get-v1badgesgroups"
+ ]
+ }, {
+ "group": "Client certificates",
+ "pages": [
+ "api-reference/client-certificates/lists-all-client-certificates",
+ "api-reference/client-certificates/creates-a-new-client-certificate",
+ "api-reference/client-certificates/shows-one-client-certificate",
+ "api-reference/client-certificates/deletes-a-client-certificate"
+ ]
+ },
+ {
+ "group": "Triggers",
+ "pages": [
+ "api-reference/triggers/get-the-check-group-trigger",
+ "api-reference/triggers/create-the-check-group-trigger",
+ "api-reference/triggers/delete-the-check-group-trigger",
+ "api-reference/triggers/get-the-check-trigger",
+ "api-reference/triggers/create-the-check-trigger",
+ "api-reference/triggers/delete-the-check-trigger"
+ ]
+ }
]
},
{
- "group": "Status Page Incidents",
+ "group": "DETECT",
"pages": [
- "api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination",
- "api-reference/status-page-incidents/create-a-new-incident",
- "api-reference/status-page-incidents/retrieve-an-incident-by-id",
- "api-reference/status-page-incidents/update-an-existing-incident",
- "api-reference/status-page-incidents/delete-an-incident",
- "api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident",
- "api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident",
- "api-reference/status-page-incidents/retrieve-an-incident-update-by-id",
- "api-reference/status-page-incidents/update-an-existing-incident-update",
- "api-reference/status-page-incidents/delete-an-incident-update"
+ {
+ "group": "Uptime Monitoring",
+ "pages": [
+
+ {
+ "group": "Heartbeats",
+ "pages": [
+ "api-reference/heartbeats/create-a-heartbeat-check",
+ "api-reference/heartbeats/update-a-heartbeat-check",
+ "api-reference/heartbeats/get-heartbeat-availability",
+ "api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat",
+ "api-reference/heartbeats/get-a-specific-heartbeat-event"
+ ]
+ },
+ {
+ "group": "URL Monitors",
+ "pages": [
+ "api-reference/monitors/create-a-url-monitor",
+ "api-reference/monitors/update-an-url-monitor"
+ ]
+ },
+ {
+ "group": "TCP Monitors",
+ "pages": [
+ "api-reference/checks/create-a-tcp-check",
+ "api-reference/checks/update-an-tcp-check"
+ ]
+ },
+ {
+ "group": "DNS Monitors",
+ "pages": [
+ "api-reference/monitors/create-a-url-monitor",
+ "api-reference/monitors/update-an-url-monitor"
+ ]
+ }
+ ]
+ },
+ {
+ "group": "Synthetic Monitoring",
+ "pages": [
+ "api-reference/checks/list-all-checks",
+ "api-reference/checks/create-an-api-check",
+ "api-reference/checks/update-an-api-check",
+ "api-reference/checks/create-a-browser-check",
+ "api-reference/checks/update-a-browser-check",
+ "api-reference/checks/create-a-multi-step-check",
+ "api-reference/checks/update-a-multi-step-check",
+ "api-reference/checks/retrieve-a-check",
+ "api-reference/checks/delete-a-check",
+ "api-reference/checks/create-a-check",
+ "api-reference/checks/update-a-check"
+ ]
+ },
+ {
+ "group": "Locations",
+ "pages": [
+ "api-reference/location/lists-all-supported-locations",
+ "api-reference/private-locations/list-all-private-locations",
+ "api-reference/private-locations/create-a-private-location",
+ "api-reference/private-locations/retrieve-a-private-location",
+ "api-reference/private-locations/update-a-private-location",
+ "api-reference/private-locations/remove-a-private-location",
+ "api-reference/private-locations/generate-a-new-api-key-for-a-private-location",
+ "api-reference/private-locations/remove-an-existing-api-key-for-a-private-location",
+ "api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time"
+ ]
+ },
+
+
+ {
+ "group": "Check Groups",
+ "pages": [
+ "api-reference/check-groups/list-all-check-groups",
+ "api-reference/check-groups/create-a-check-group",
+ "api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied",
+ "api-reference/check-groups/retrieve-a-check-group",
+ "api-reference/check-groups/update-a-check-group",
+ "api-reference/check-groups/delete-a-check-group",
+ "api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied",
+ "api-reference/check-groups/create-a-check-group-v2",
+ "api-reference/check-groups/update-a-check-group-v2"
+ ]
+ },
+
+ {
+ "group": "Check Sessions",
+ "pages": [
+ "api-reference/check-sessions/trigger-a-new-check-session",
+ "api-reference/check-sessions/retrieve-a-check-session",
+ "api-reference/check-sessions/await-the-completion-of-a-check-session"
+ ]
+ },
+ {
+ "group": "Check Status",
+ "pages": [
+ "api-reference/check-status/list-all-check-statuses",
+ "api-reference/check-status/retrieve-check-status-details"
+ ]
+ }
]
},
{
- "group": "Status Page Services",
+ "group": "COMMUNICATE",
"pages": [
- "api-reference/status-page-services/get-all-services",
- "api-reference/status-page-services/create-a-service",
- "api-reference/status-page-services/get-a-single-service",
- "api-reference/status-page-services/update-a-service",
- "api-reference/status-page-services/delete-a-service"
+ {
+ "group": "Alert Channels",
+ "pages": [
+ "api-reference/alert-channels/list-all-alert-channels",
+ "api-reference/alert-channels/create-an-alert-channel",
+ "api-reference/alert-channels/retrieve-an-alert-channel",
+ "api-reference/alert-channels/update-an-alert-channel",
+ "api-reference/alert-channels/delete-an-alert-channel",
+ "api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel"
+ ]
+ },
+ {
+ "group": "Alert Notifications",
+ "pages": [
+ "api-reference/alert-notifications/lists-all-alert-notifications"
+ ]
+ },{
+ "group": "Check Alerts",
+ "pages": [
+ "api-reference/check-alerts/list-all-alerts-for-your-account",
+ "api-reference/check-alerts/list-alerts-for-a-specific-check"
+ ]
+ },
+
+ {
+ "group": "Status Pages",
+ "pages": [
+ "api-reference/status-pages/retrieve-all-status-pages",
+ "api-reference/status-pages/create-a-new-status-page",
+ "api-reference/status-pages/retrieve-a-single-status-page-by-id",
+ "api-reference/status-pages/update-an-existing-status-page",
+ "api-reference/status-pages/delete-a-status-page",
+ "api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page",
+ "api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page"
+ ]
+ },
+ {
+ "group": "Status Page Incidents",
+ "pages": [
+ "api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination",
+ "api-reference/status-page-incidents/create-a-new-incident",
+ "api-reference/status-page-incidents/retrieve-an-incident-by-id",
+ "api-reference/status-page-incidents/update-an-existing-incident",
+ "api-reference/status-page-incidents/delete-an-incident",
+ "api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident",
+ "api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident",
+ "api-reference/status-page-incidents/retrieve-an-incident-update-by-id",
+ "api-reference/status-page-incidents/update-an-existing-incident-update",
+ "api-reference/status-page-incidents/delete-an-incident-update"
+ ]
+ },
+ {
+ "group": "Status Page Services",
+ "pages": [
+ "api-reference/status-page-services/get-all-services",
+ "api-reference/status-page-services/create-a-service",
+ "api-reference/status-page-services/get-a-single-service",
+ "api-reference/status-page-services/update-a-service",
+ "api-reference/status-page-services/delete-a-service"
+ ]
+ },
+
+ {
+ "group": "Incidents",
+ "pages": [
+ "api-reference/incidents/create-an-incident",
+ "api-reference/incidents/retrieve-an-incident",
+ "api-reference/incidents/update-an-incident",
+ "api-reference/incidents/delete-an-incident"
+ ]
+ },
+ {
+ "group": "Incident Updates",
+ "pages": [
+ "api-reference/incident-updates/create-an-incident-update",
+ "api-reference/incident-updates/update-an-incident-update",
+ "api-reference/incident-updates/delete-an-incident-update"
+ ]
+ },
+ {
+ "group": "Maintenance windows",
+ "pages": [
+ "api-reference/maintenance-windows/list-all-maintenance-windows",
+ "api-reference/maintenance-windows/create-a-maintenance-window",
+ "api-reference/maintenance-windows/retrieve-a-maintenance-window",
+ "api-reference/maintenance-windows/update-a-maintenance-window",
+ "api-reference/maintenance-windows/delete-a-maintenance-window"
+ ]
+ },
+ {
+ "group": "Dashboards",
+ "pages": [
+ "api-reference/dashboards/list-all-dashboards",
+ "api-reference/dashboards/create-a-dashboard",
+ "api-reference/dashboards/retrieve-a-dashboard",
+ "api-reference/dashboards/update-a-dashboard",
+ "api-reference/dashboards/delete-a-dashboard"
+ ]
+ }
]
},
{
- "group": "Triggers",
+ "group": "RESOLVE",
"pages": [
- "api-reference/triggers/get-the-check-group-trigger",
- "api-reference/triggers/create-the-check-group-trigger",
- "api-reference/triggers/delete-the-check-group-trigger",
- "api-reference/triggers/get-the-check-trigger",
- "api-reference/triggers/create-the-check-trigger",
- "api-reference/triggers/delete-the-check-trigger"
+
+ {
+ "group": "OpenTelemetry",
+ "pages": [
+ "api-reference/opentelemetry/post-accounts-metrics"
+
+ ]
+ }
]
},
{
- "group": "Environment variables",
+ "group": "REPORTING",
"pages": [
- "api-reference/environment-variables/list-all-environment-variables",
- "api-reference/environment-variables/create-an-environment-variable",
- "api-reference/environment-variables/retrieve-an-environment-variable",
- "api-reference/environment-variables/update-an-environment-variable",
- "api-reference/environment-variables/delete-an-environment-variable"
+
+ {
+ "group": "Analytics",
+ "pages": [
+ "api-reference/analytics/api-checks",
+ "api-reference/analytics/browser-checks",
+ "api-reference/analytics/heartbeat-checks",
+ "api-reference/analytics/list-all-available-reporting-metrics",
+ "api-reference/analytics/multistep-checks",
+ "api-reference/analytics/playwright-checks",
+ "api-reference/analytics/tcp-checks",
+ "api-reference/analytics/url-monitors"
+
+ ]
+ },
+ {
+ "group": "Check Results",
+ "pages": [
+ "api-reference/check-results/lists-all-check-results",
+ "api-reference/check-results/retrieve-a-check-result",
+ "api-reference/check-results/lists-all-check-results-1"
+ ]
+ },
+ {
+ "group": "Reporting",
+ "pages": [
+ "api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups"
+ ]
+ }
]
}
+
+
+
+
+
+
+
+
+
+
+
]
},
{
diff --git a/update-api-spec.sh b/update-api-spec.sh
index b95491f2..e9b9c122 100755
--- a/update-api-spec.sh
+++ b/update-api-spec.sh
@@ -17,22 +17,35 @@ if [ ! -s "$TEMP_FILE" ]; then
fi
echo "🔧 Cleaning up HTML in descriptions..."
-# Convert common HTML tags to Markdown in the authorization description
+# Convert common HTML tags to Markdown
+# Order matters: convert first so patterns work on remaining content
# Use cross-platform sed syntax (works on both macOS and Linux)
if sed --version 2>&1 | grep -q GNU; then
# GNU sed (Linux)
sed -i 's|]*href=\\"\([^"]*\)\\"[^>]*>\([^<]*\)|[\2](\1)|g' "$TEMP_FILE"
+ # Convert tags first
+ sed -i 's|\([^<]*\)|`\1`|g' "$TEMP_FILE"
+ # Handle line breaks
sed -i 's||\n|g' "$TEMP_FILE"
+ sed -i 's|
|\n|g' "$TEMP_FILE"
sed -i 's|
|\n|g' "$TEMP_FILE"
+ # Handle malformed ... (missing slash in closing tag)
+ sed -i 's|\([^<]*\)|**\1**|g' "$TEMP_FILE"
+ # Handle properly formed ...
sed -i 's|\([^<]*\)|**\1**|g' "$TEMP_FILE"
- sed -i 's|\([^<]*\)|`\1`|g' "$TEMP_FILE"
else
# BSD sed (macOS)
sed -i.tmp 's|]*href=\\"\([^"]*\)\\"[^>]*>\([^<]*\)|[\2](\1)|g' "$TEMP_FILE"
+ # Convert tags first
+ sed -i.tmp 's|\([^<]*\)|`\1`|g' "$TEMP_FILE"
+ # Handle line breaks
sed -i.tmp 's||\n|g' "$TEMP_FILE"
+ sed -i.tmp 's|
|\n|g' "$TEMP_FILE"
sed -i.tmp 's|
|\n|g' "$TEMP_FILE"
+ # Handle malformed ... (missing slash in closing tag)
+ sed -i.tmp 's|\([^<]*\)|**\1**|g' "$TEMP_FILE"
+ # Handle properly formed ...
sed -i.tmp 's|\([^<]*\)|**\1**|g' "$TEMP_FILE"
- sed -i.tmp 's|\([^<]*\)|`\1`|g' "$TEMP_FILE"
fi
echo "✅ Validating OpenAPI specification..."