analytics
Checkly MCP, CLI, and Lua Integration for AI Agents
Checkly integration docs for AI agents: MCP gateway setup, Checkly CLI commands, Lua API reference, credentials, and function schemas.Checkly for agents
Credentials can be configured manually in web or CLI hosts.
Use this integration from Lua code mode, the headless integrations CLI, or the KosmoKrator MCP gateway. The same package metadata powers all three surfaces.
Agent Surfaces
Machine-Readable Metadata
Function Catalog
| Function | Type | Parameters | Description |
|---|---|---|---|
checkly.checkly_get_v1_accounts | Read read | 0 | List account details based on supplied API key. Official Checkly endpoint: GET /v1/accounts. |
checkly.checkly_get_v1_accounts_me | Read read | 0 | Get details from the current account. Official Checkly endpoint: GET /v1/accounts/me. |
checkly.checkly_get_v1_accounts_me_entitlements | Read read | 0 | Fetch the entitlements for the account, including feature access and limits based on the current plan. Official Checkly endpoint: GET /v1/accounts/me/entitlements. |
checkly.checkly_get_v1_accounts_accountid | Read read | 0 | Get details from a specific account. Official Checkly endpoint: GET /v1/accounts/{accountId}. |
checkly.checkly_get_v1_accounts_accountid_entitlements | Read read | 0 | Fetch the entitlements for the account, including feature access and limits based on the current plan. Official Checkly endpoint: GET /v1/accounts/{accountId}/entitlements. |
checkly.checkly_get_v1_alertchannels | Read read | 0 | Lists all configured alert channels and their subscribed checks. Official Checkly endpoint: GET /v1/alert-channels. |
checkly.checkly_post_v1_alertchannels | Write write | 0 | Creates a new alert channel Official Checkly endpoint: POST /v1/alert-channels. |
checkly.checkly_delete_v1_alertchannels_id | Write write | 0 | Permanently removes an alert channel Official Checkly endpoint: DELETE /v1/alert-channels/{id}. |
checkly.checkly_get_v1_alertchannels_id | Read read | 0 | Show details of a specific alert channel. Official Checkly endpoint: GET /v1/alert-channels/{id}. |
checkly.checkly_put_v1_alertchannels_id | Write write | 0 | Update an alert channel Official Checkly endpoint: PUT /v1/alert-channels/{id}. |
checkly.checkly_put_v1_alertchannels_id_subscriptions | Write write | 0 | 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. Officia |
checkly.checkly_get_v1_alertnotifications | Read read | 0 | 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 dat |
checkly.checkly_get_v1_analytics_apichecks_id | Read read | 0 | 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. Rat |
checkly.checkly_get_v1_analytics_browserchecks_id | Read read | 0 | 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 |
checkly.checkly_post_v1_analytics_checks | Write write | 0 | Returns availability, response times, and latency metrics for the given checks. Response shape is polymorphic per check type: fields are present only when the metric applies to that type. A null value means no data in the requested time range; an absent field |
checkly.checkly_get_v1_analytics_dns_id | Read read | 0 | Fetch detailed availability metrics and aggregated or non-aggregated DNS Monitor metrics across custom time ranges. For example, you can get the p99 and p95 of the total DNS query time together with the availability percentage for any time range. Rate-limiting |
checkly.checkly_get_v1_analytics_heartbeatchecks_id | Read read | 0 | 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. Official Checkly endpoint: GET /v1/analytics/hea |
checkly.checkly_get_v1_analytics_icmp_id | Read read | 0 | Fetch detailed availability metrics and aggregated or non-aggregated ICMP Monitor metrics across custom time ranges. For example, you can get the p99 and p95 of latency metrics together with the packet loss percentage for any time range. Rate-limiting is appli |
checkly.checkly_get_v1_analytics_metrics | Read read | 0 | List all available reporting metrics. Official Checkly endpoint: GET /v1/analytics/metrics. |
checkly.checkly_get_v1_analytics_multistepchecks_id | Read read | 0 | 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. Official Checkly endpoint: GET /v1/analytics/mult |
checkly.checkly_get_v1_analytics_playwrightchecks_id | Read read | 0 | 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. Official Checkly endpoint: GET /v1/analytics/pla |
checkly.checkly_get_v1_analytics_tcpchecks_id | Read read | 0 | 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. R |
checkly.checkly_get_v1_analytics_urlmonitors_id | Read read | 0 | 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. Rat |
checkly.checkly_get_v1_badges_checks_checkid | Read read | 0 | Get check status badge. You can enable the badges feature in account settings Official Checkly endpoint: GET /v1/badges/checks/{checkId}. |
checkly.checkly_get_v1_badges_groups_groupid | Read read | 0 | Get group status badge. You can enable the badges feature in account settings Official Checkly endpoint: GET /v1/badges/groups/{groupId}. |
checkly.checkly_cancel | Write write | 0 | Cancel a check run, check session, test run, or test session Official Checkly endpoint: POST /v1/cancel. |
checkly.checkly_get_v1_checkalerts | Read read | 0 | 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 |
checkly.checkly_get_v1_checkalerts_checkid | Read read | 0 | 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 apa |
checkly.checkly_get_v1_checkgroups | Read read | 0 | 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. Official Checkly endpoint: GET /v1/check-groups. |
checkly.checkly_post_v1_checkgroups | Write write | 0 | Creates a new check group. You can add checks to the group by setting the "groupId" property of individual checks. Official Checkly endpoint: POST /v1/check-groups. |
checkly.checkly_get_v1_checkgroups_groupid_checks_checkid | Read read | 0 | Show details of one check in a specific check group with the group settings applied. Official Checkly endpoint: GET /v1/check-groups/{groupId}/checks/{checkId}. |
checkly.checkly_delete_v1_checkgroups_id | Write write | 0 | Permanently removes a check group. You cannot delete a check group if it still contains checks. Official Checkly endpoint: DELETE /v1/check-groups/{id}. |
checkly.checkly_get_v1_checkgroups_id | Read read | 0 | Show details of a specific check group Official Checkly endpoint: GET /v1/check-groups/{id}. |
checkly.checkly_put_v1_checkgroups_id | Write write | 0 | Updates a check group. Official Checkly endpoint: PUT /v1/check-groups/{id}. |
checkly.checkly_get_v1_checkgroups_id_checks | Read read | 0 | Lists all checks in a specific check group with the group settings applied. Official Checkly endpoint: GET /v1/check-groups/{id}/checks. |
checkly.checkly_get_v1_checkresults_checkid | Read read | 0 | [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 rolle |
checkly.checkly_get_v1_checkresults_checkid_checkresultid | Read read | 0 | Show details of a specific check result. Official Checkly endpoint: GET /v1/check-results/{checkId}/{checkResultId}. |
checkly.checkly_post_v1_checksessions_trigger | Write write | 0 | Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks. This endpoint does not wait for the check session to complete. Use the `GET /v1/check-sessions/{checkSessionId}/completion` or |
checkly.checkly_get_v1_checksessions_checksessionid | Read read | 0 | Retrieves a check session. Results may be incomplete if the check session is still in progress. Once a check session has finished, results will include at least one check result for each run location: one result with `resultType` equal to `"FINAL"`, and zero o |
checkly.checkly_get_v1_checksessions_checksessionid_completion | Read read | 0 | 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). If the check session takes a long time to complete, the endpoint will return a |
checkly.checkly_get_v1_checkstatuses | Read read | 0 | Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in. Official Checkly endpoint: GET /v1/check-statuses. |
checkly.checkly_get_v1_checkstatuses_checkid | Read read | 0 | Show the current status information for a specific check. Official Checkly endpoint: GET /v1/check-statuses/{checkId}. |
checkly.checkly_get_v1_checks | Read read | 0 | Lists all current checks in your account. Official Checkly endpoint: GET /v1/checks. |
checkly.checkly_post_v1_checks | Write write | 0 | [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. When using the `globalAlertSettings`, the `alertSettings` c |
checkly.checkly_post_v1_checks_api | Write write | 0 | Creates a new API check. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/api. |
checkly.checkly_put_v1_checks_api_id | Write write | 0 | Updates an API check. Official Checkly endpoint: PUT /v1/checks/api/{id}. |
checkly.checkly_post_v1_checks_browser | Write write | 0 | Creates a new browser check. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/browser. |
checkly.checkly_put_v1_checks_browser_id | Write write | 0 | Updates a browser check. Official Checkly endpoint: PUT /v1/checks/browser/{id}. |
checkly.checkly_post_v1_checks_dns | Write write | 0 | Creates a new DNS monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/dns. |
checkly.checkly_put_v1_checks_dns_id | Write write | 0 | Updates an DNS monitor. Official Checkly endpoint: PUT /v1/checks/dns/{id}. |
checkly.checkly_post_v1_checks_heartbeat | Write write | 0 | Creates a new Heartbeat check. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/heartbeat. |
checkly.checkly_put_v1_checks_heartbeat_id | Write write | 0 | Updates a Heartbeat check. Official Checkly endpoint: PUT /v1/checks/heartbeat/{id}. |
checkly.checkly_get_v1_checks_heartbeats_checkid_availability | Read read | 0 | Get heartbeat availability. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/availability. |
checkly.checkly_get_v1_checks_heartbeats_checkid_events | Read read | 0 | Get all events from a heartbeat. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/events. |
checkly.checkly_get_v1_checks_heartbeats_checkid_events_id | Read read | 0 | Get a specific event by its id. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/events/{id}. |
checkly.checkly_post_v1_checks_icmp | Write write | 0 | Creates a new ICMP monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/icmp. |
checkly.checkly_put_v1_checks_icmp_id | Write write | 0 | Updates an ICMP monitor. Official Checkly endpoint: PUT /v1/checks/icmp/{id}. |
checkly.checkly_post_v1_checks_multistep | Write write | 0 | Creates a new Multi-Step check. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/multistep. |
checkly.checkly_put_v1_checks_multistep_id | Write write | 0 | Updates a Multi-Step check. Official Checkly endpoint: PUT /v1/checks/multistep/{id}. |
checkly.checkly_post_v1_checks_tcp | Write write | 0 | Creates a new TCP check. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/tcp. |
checkly.checkly_put_v1_checks_tcp_id | Write write | 0 | Updates an TCP check. Official Checkly endpoint: PUT /v1/checks/tcp/{id}. |
checkly.checkly_post_v1_checks_url | Write write | 0 | Creates a new URL monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` Official Checkly endpoint: POST /v1/checks/url. |
checkly.checkly_put_v1_checks_url_id | Write write | 0 | Updates an URL monitor. Official Checkly endpoint: PUT /v1/checks/url/{id}. |
checkly.checkly_delete_v1_checks_id | Write write | 0 | Permanently removes a API or browser check and all its related status and results data. Official Checkly endpoint: DELETE /v1/checks/{id}. |
checkly.checkly_get_v1_checks_id | Read read | 0 | Show details of a specific API or browser check Official Checkly endpoint: GET /v1/checks/{id}. |
checkly.checkly_put_v1_checks_id | Write write | 0 | [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. Official Checkly endpoint: PUT /v1/checks/{id}. |
checkly.checkly_get_v1_clientcertificates | Read read | 0 | Lists all client certificates. Official Checkly endpoint: GET /v1/client-certificates. |
checkly.checkly_post_v1_clientcertificates | Write write | 0 | Creates a new client certificate. Official Checkly endpoint: POST /v1/client-certificates. |
checkly.checkly_delete_v1_clientcertificates_id | Write write | 0 | Permanently removes a client certificate. Official Checkly endpoint: DELETE /v1/client-certificates/{id}. |
checkly.checkly_get_v1_clientcertificates_id | Read read | 0 | Shows one client certificate. Official Checkly endpoint: GET /v1/client-certificates/{id}. |
checkly.checkly_get_v1_dashboards | Read read | 0 | Lists all current dashboards in your account. Official Checkly endpoint: GET /v1/dashboards. |
checkly.checkly_post_v1_dashboards | Write write | 0 | 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. Official Checkly endpoint: POST /v1/dashboards. |
checkly.checkly_delete_v1_dashboards_dashboardid | Write write | 0 | Permanently removes a dashboard. Official Checkly endpoint: DELETE /v1/dashboards/{dashboardId}. |
checkly.checkly_get_v1_dashboards_dashboardid | Read read | 0 | Show details of a specific dashboard. Rate-limiting is applied to this endpoint, you can send 10 requests / 20 seconds at most. Official Checkly endpoint: GET /v1/dashboards/{dashboardId}. |
checkly.checkly_put_v1_dashboards_dashboardid | Write write | 0 | Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken. Official Checkly endpoint: PUT /v1/dashboards/{dashboardId}. |
checkly.checkly_get_v1_errorgroups | Read read | 0 | List all error groups in your account. Official Checkly endpoint: GET /v1/error-groups. |
checkly.checkly_get_v1_errorgroups_checks_checkid | Read read | 0 | List all error groups for a specific check. Official Checkly endpoint: GET /v1/error-groups/checks/{checkId}. |
checkly.checkly_get_v1_errorgroups_id | Read read | 0 | Retrieve one error group. Official Checkly endpoint: GET /v1/error-groups/{id}. |
checkly.checkly_patch_v1_errorgroups_id | Write write | 0 | Update an error group. Mainly used for archiving error groups. Official Checkly endpoint: PATCH /v1/error-groups/{id}. |
checkly.checkly_post_v1_incidents | Write write | 0 | Creates a new incident. Official Checkly endpoint: POST /v1/incidents. |
checkly.checkly_delete_v1_incidents_id | Write write | 0 | Permanently removes an incident and all its updates. Official Checkly endpoint: DELETE /v1/incidents/{id}. |
checkly.checkly_get_v1_incidents_id | Read read | 0 | Shows details of a specific incident. Uses the "includeAllIncidentUpdates" query parameter to obtain all updates. Official Checkly endpoint: GET /v1/incidents/{id}. |
checkly.checkly_put_v1_incidents_id | Write write | 0 | Updates an incident. Official Checkly endpoint: PUT /v1/incidents/{id}. |
checkly.checkly_post_v1_incidents_incidentid_updates | Write write | 0 | Creates a new update for an incident. Official Checkly endpoint: POST /v1/incidents/{incidentId}/updates. |
checkly.checkly_delete_v1_incidents_incidentid_updates_id | Write write | 0 | Permanently removes an incident update. Official Checkly endpoint: DELETE /v1/incidents/{incidentId}/updates/{id}. |
checkly.checkly_put_v1_incidents_incidentid_updates_id | Write write | 0 | Modifies an incident update. Official Checkly endpoint: PUT /v1/incidents/{incidentId}/updates/{id}. |
checkly.checkly_get_v1_locations | Read read | 0 | Lists all supported locationss. Official Checkly endpoint: GET /v1/locations. |
checkly.checkly_get_v1_maintenancewindows | Read read | 0 | Lists all maintenance windows in your account. Official Checkly endpoint: GET /v1/maintenance-windows. |
checkly.checkly_post_v1_maintenancewindows | Write write | 0 | Creates a new maintenance window. Official Checkly endpoint: POST /v1/maintenance-windows. |
checkly.checkly_delete_v1_maintenancewindows_id | Write write | 0 | Permanently removes a maintenance window. Official Checkly endpoint: DELETE /v1/maintenance-windows/{id}. |
checkly.checkly_get_v1_maintenancewindows_id | Read read | 0 | Show details of a specific maintenance window. Official Checkly endpoint: GET /v1/maintenance-windows/{id}. |
checkly.checkly_put_v1_maintenancewindows_id | Write write | 0 | Updates a maintenance window. Official Checkly endpoint: PUT /v1/maintenance-windows/{id}. |
checkly.checkly_get_v1_privatelocations | Read read | 0 | Lists all private locations in your account. Official Checkly endpoint: GET /v1/private-locations. |
checkly.checkly_post_v1_privatelocations | Write write | 0 | Creates a new private location. Official Checkly endpoint: POST /v1/private-locations. |
checkly.checkly_delete_v1_privatelocations_id | Write write | 0 | Permanently removes a private location. Official Checkly endpoint: DELETE /v1/private-locations/{id}. |
checkly.checkly_get_v1_privatelocations_id | Read read | 0 | Show details of a specific private location. Official Checkly endpoint: GET /v1/private-locations/{id}. |
checkly.checkly_put_v1_privatelocations_id | Write write | 0 | Updates a private location. Official Checkly endpoint: PUT /v1/private-locations/{id}. |
checkly.checkly_post_v1_privatelocations_id_keys | Write write | 0 | Creates an api key on the private location. Official Checkly endpoint: POST /v1/private-locations/{id}/keys. |
checkly.checkly_delete_v1_privatelocations_id_keys_keyid | Write write | 0 | Permanently removes an api key from a private location. Official Checkly endpoint: DELETE /v1/private-locations/{id}/keys/{keyId}. |
checkly.checkly_get_v1_privatelocations_id_metrics | Read read | 0 | 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. Official Checkly endpoint: GET /v1/private-locations/{id}/metrics. |
checkly.checkly_get_v1_reporting | Read read | 0 | Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window. Official Checkly endpoint: GET /v1/reporting. |
checkly.checkly_post_v1_rootcauseanalyses_errorgroups_errorgroupid | Write write | 0 | Asynchronously generates a root cause analysis for a specific check error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint. Official Checkly endpoint: POST /v1/root-cause-analyses/error-groups/{errorGroupId}. |
checkly.checkly_post_v1_rootcauseanalyses_testsessionerrorgroups_testsessionerrorgroupid | Write write | 0 | Asynchronously generates a root cause analysis for a specific test session error group. Returns an `id` which you can use to poll the `/root-cause-analyses/{id}` endpoint. Official Checkly endpoint: POST /v1/root-cause-analyses/test-session-error-groups/{test |
checkly.checkly_get_v1_rootcauseanalyses_id | Read read | 0 | Retrieves a specific root cause analysis. Use the `id` returned from either POST endpoint and poll until the response is HTTP 200. While the analysis is being generated the endpoint returns HTTP 202 with `{"id":"","status":"PENDING"}`. A genuine HTTP 404 means |
checkly.checkly_get_v1_runtimes | Read read | 0 | Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks. Official Checkly endpoint: GET /v1/runtimes. |
checkly.checkly_get_v1_runtimes_id | Read read | 0 | Shows the details of all included NPM packages and their version for one specific runtime Official Checkly endpoint: GET /v1/runtimes/{id}. |
checkly.checkly_get_v1_snippets | Read read | 0 | Lists all current snippets in your account. Official Checkly endpoint: GET /v1/snippets. |
checkly.checkly_post_v1_snippets | Write write | 0 | Creates a new snippet. Official Checkly endpoint: POST /v1/snippets. |
checkly.checkly_delete_v1_snippets_id | Write write | 0 | Permanently removes a snippet. Official Checkly endpoint: DELETE /v1/snippets/{id}. |
checkly.checkly_get_v1_snippets_id | Read read | 0 | Show details of a specific snippet. Official Checkly endpoint: GET /v1/snippets/{id}. |
checkly.checkly_put_v1_snippets_id | Write write | 0 | Updates a snippet. Official Checkly endpoint: PUT /v1/snippets/{id}. |
checkly.checkly_get_v1_staticips | Read read | 0 | Lists all source IPs for check runs as a single JSON array. Official Checkly endpoint: GET /v1/static-ips. |
checkly.checkly_get_v1_staticipsbyregion | Read read | 0 | Lists all source IPs for check runs as object with regions as keys and an array of IPs as value. Official Checkly endpoint: GET /v1/static-ips-by-region. |
checkly.checkly_get_v1_staticipstxt | Read read | 0 | Lists all IPs for check runs as a TXT file. Each line has one IP. Official Checkly endpoint: GET /v1/static-ips.txt. |
checkly.checkly_get_v1_staticipv6s | Read read | 0 | Lists all source IPv6s for check runs as a single JSON array. Official Checkly endpoint: GET /v1/static-ipv6s. |
checkly.checkly_get_v1_staticipv6sbyregion | Read read | 0 | Lists all source IPs for check runs as an object with regions as keys and an Ipv6 as value. Official Checkly endpoint: GET /v1/static-ipv6s-by-region. |
checkly.checkly_get_v1_staticipv6stxt | Read read | 0 | Lists all IPv6s for check runs as a TXT file. Each line has one IP. Official Checkly endpoint: GET /v1/static-ipv6s.txt. |
checkly.checkly_get_v1_statuspages | Read read | 0 | Get all status pages for an account. Official Checkly endpoint: GET /v1/status-pages. |
checkly.checkly_post_v1_statuspages | Write write | 0 | Create a new status page with its related services and cards. Official Checkly endpoint: POST /v1/status-pages. |
checkly.checkly_get_v1_statuspages_incidents | Read read | 0 | Get the latest 100 incidents for all services. Official Checkly endpoint: GET /v1/status-pages/incidents. |
checkly.checkly_post_v1_statuspages_incidents | Write write | 0 | Creates a new incident. Official Checkly endpoint: POST /v1/status-pages/incidents. |
checkly.checkly_delete_v1_statuspages_incidents_incidentid | Write write | 0 | Permanently removes an incident and all its updates. Official Checkly endpoint: DELETE /v1/status-pages/incidents/{incidentId}. |
checkly.checkly_get_v1_statuspages_incidents_incidentid | Read read | 0 | Get incident details including incident history and affected services. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}. |
checkly.checkly_put_v1_statuspages_incidents_incidentid | Write write | 0 | Updates an incident. Official Checkly endpoint: PUT /v1/status-pages/incidents/{incidentId}. |
checkly.checkly_get_v1_statuspages_incidents_incidentid_incidentupdates | Read read | 0 | Lists all updates for a specific incident. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}/incident-updates. |
checkly.checkly_post_v1_statuspages_incidents_incidentid_incidentupdates | Write write | 0 | Creates a new update for an incident. Official Checkly endpoint: POST /v1/status-pages/incidents/{incidentId}/incident-updates. |
checkly.checkly_delete_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid | Write write | 0 | Permanently removes an incident update. Official Checkly endpoint: DELETE /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}. |
checkly.checkly_get_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid | Read read | 0 | Shows details of a specific incident update. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}. |
checkly.checkly_put_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid | Write write | 0 | Modifies an incident update. Official Checkly endpoint: PUT /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}. |
checkly.checkly_get_v1_statuspages_services | Read read | 0 | Get all services Official Checkly endpoint: GET /v1/status-pages/services. |
checkly.checkly_post_v1_statuspages_services | Write write | 0 | Create a service Official Checkly endpoint: POST /v1/status-pages/services. |
checkly.checkly_delete_v1_statuspages_services_serviceid | Write write | 0 | Delete a service Official Checkly endpoint: DELETE /v1/status-pages/services/{serviceId}. |
checkly.checkly_get_v1_statuspages_services_serviceid | Read read | 0 | Get a single service Official Checkly endpoint: GET /v1/status-pages/services/{serviceId}. |
checkly.checkly_put_v1_statuspages_services_serviceid | Write write | 0 | Update a service Official Checkly endpoint: PUT /v1/status-pages/services/{serviceId}. |
checkly.checkly_delete_v1_statuspages_statuspageid | Write write | 0 | Delete a status page. Official Checkly endpoint: DELETE /v1/status-pages/{statusPageId}. |
checkly.checkly_get_v1_statuspages_statuspageid | Read read | 0 | Get status page data, including cards and services. Official Checkly endpoint: GET /v1/status-pages/{statusPageId}. |
checkly.checkly_put_v1_statuspages_statuspageid | Write write | 0 | Update a status page with its related services and cards. Official Checkly endpoint: PUT /v1/status-pages/{statusPageId}. |
checkly.checkly_get_v1_statuspages_statuspageid_subscriptions | Read read | 0 | Get all subscriptions for a specific status page Official Checkly endpoint: GET /v1/status-pages/{statusPageId}/subscriptions. |
checkly.checkly_post_v1_statuspages_statuspageid_subscriptions_bulk | Write write | 0 | Bulk create subscriptions for a specific status page. Official Checkly endpoint: POST /v1/status-pages/{statusPageId}/subscriptions/bulk. |
checkly.checkly_delete_v1_statuspages_statuspageid_subscriptions_subscriptionid | Write write | 0 | Delete a subscription belonging to a specific status page using the subscription id Official Checkly endpoint: DELETE /v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}. |
checkly.checkly_get_v1_testsessionerrorgroups | Read read | 0 | List all test session error groups in your account. Official Checkly endpoint: GET /v1/test-session-error-groups. |
checkly.checkly_get_v1_testsessionerrorgroups_projects_projectid | Read read | 0 | List all test session error groups for a specific project. Official Checkly endpoint: GET /v1/test-session-error-groups/projects/{projectId}. |
checkly.checkly_get_v1_testsessionerrorgroups_id | Read read | 0 | Retrieve one test session error group. Official Checkly endpoint: GET /v1/test-session-error-groups/{id}. |
checkly.checkly_patch_v1_testsessionerrorgroups_id | Write write | 0 | Update a test session error group. Mainly used for archiving test session error groups. Official Checkly endpoint: PATCH /v1/test-session-error-groups/{id}. |
checkly.checkly_post_v1_testsessions_trigger | Write write | 0 | Starts a tests session with checks matching the provided target filters. If no filters are given, matches all eligible checks. This endpoint does not wait for the test session to complete. Use the `GET /v1/test-sessions/{testSessionId}/completion` or `GET /v1/ |
checkly.checkly_get_v1_testsessions_testsessionid | Read read | 0 | Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress. Official Checkly endpoint: GET /v1/test-sessions/{testSessionId}. |
checkly.checkly_get_v1_testsessions_testsessionid_completion | Read read | 0 | Call this endpoint to await the completion of a test session. A successful response code will be returned once the test session reaches its final state (i.e. when it passes or fails). If the test session takes a long time to complete, the endpoint will return |
checkly.checkly_delete_v1_triggers_checkgroups_groupid | Write write | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Deletes the check groups trigger Official Checkly endpoint: DELETE /v1/triggers/check-groups/{groupId}. |
checkly.checkly_get_v1_triggers_checkgroups_groupid | Read read | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Finds the check group trigger Official Checkly endpoint: GET /v1/triggers/check-groups/{groupId}. |
checkly.checkly_post_v1_triggers_checkgroups_groupid | Write write | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Creates the check group trigger Official Checkly endpoint: POST /v1/triggers/check-groups/{groupId}. |
checkly.checkly_delete_v1_triggers_checks_checkid | Write write | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Deletes the check trigger Official Checkly endpoint: DELETE /v1/triggers/checks/{checkId}. |
checkly.checkly_get_v1_triggers_checks_checkid | Read read | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Finds the check trigger. Official Checkly endpoint: GET /v1/triggers/checks/{checkId}. |
checkly.checkly_post_v1_triggers_checks_checkid | Write write | 0 | [DEPRECATED] This endpoint will be removed soon. Please use the Checkly CLI to test and trigger checks. Creates the check trigger Official Checkly endpoint: POST /v1/triggers/checks/{checkId}. |
checkly.checkly_get_v1_variables | Read read | 0 | Lists all current environment variables in your account. Official Checkly endpoint: GET /v1/variables. |
checkly.checkly_post_v1_variables | Write write | 0 | Creates a new environment variable. Official Checkly endpoint: POST /v1/variables. |
checkly.checkly_delete_v1_variables_key | Write write | 0 | Permanently removes an environment variable. Uses the "key" field as the ID for deletion. Official Checkly endpoint: DELETE /v1/variables/{key}. |
checkly.checkly_get_v1_variables_key | Read read | 0 | Show details of a specific environment variable. Uses the "key" field for selection. Official Checkly endpoint: GET /v1/variables/{key}. |
checkly.checkly_put_v1_variables_key | Write write | 0 | 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. Official Checkly endpoint: PUT /v1/variables/{key}. |
checkly.checkly_post_v2_checkgroups | Write write | 0 | Creates a new check group. You can add checks to the group by setting the "groupId" property of individual checks. Official Checkly endpoint: POST /v2/check-groups. |
checkly.checkly_put_v2_checkgroups_id | Write write | 0 | Updates a check group. Official Checkly endpoint: PUT /v2/check-groups/{id}. |
checkly.checkly_get_v2_checkresults_checkid | Read read | 0 | 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 t |
checkly.checkly_post_v2_checksessions_trigger | Write write | 0 | Trigger a new check session Official Checkly endpoint: POST /v2/check-sessions/trigger. |
checkly.checkly_get_v2_checksessions_checksessionid | Read read | 0 | Retrieve a check session Official Checkly endpoint: GET /v2/check-sessions/{checkSessionId}. |
checkly.checkly_get_v2_checksessions_checksessionid_completion | Read read | 0 | Await the completion of a check session Official Checkly endpoint: GET /v2/check-sessions/{checkSessionId}/completion. |