List account details based on supplied API key. Official Checkly endpoint: GET /v1/accounts.

Lua path

app.integrations.checkly.get_v1_accounts

Full name

checkly.checkly_get_v1_accounts

Get details from the current account. Official Checkly endpoint: GET /v1/accounts/me.

Lua path

app.integrations.checkly.get_v1_accounts_me

Full name

checkly.checkly_get_v1_accounts_me

Fetch the entitlements for the account, including feature access and limits based on the current plan. Official Checkly endpoint: GET /v1/accounts/me/entitlements.

Lua path

app.integrations.checkly.get_v1_accounts_me_entitlements

Full name

checkly.checkly_get_v1_accounts_me_entitlements

Get details from a specific account. Official Checkly endpoint: GET /v1/accounts/{accountId}.

Lua path

app.integrations.checkly.get_v1_accounts_accountid

Full name

checkly.checkly_get_v1_accounts_accountid

Fetch the entitlements for the account, including feature access and limits based on the current plan. Official Checkly endpoint: GET /v1/accounts/{accountId}/entitlements.

Lua path

app.integrations.checkly.get_v1_accounts_accountid_entitlements

Full name

checkly.checkly_get_v1_accounts_accountid_entitlements

Lists all configured alert channels and their subscribed checks. Official Checkly endpoint: GET /v1/alert-channels.

Lua path

app.integrations.checkly.get_v1_alertchannels

Full name

checkly.checkly_get_v1_alertchannels

Creates a new alert channel Official Checkly endpoint: POST /v1/alert-channels.

Lua path

app.integrations.checkly.post_v1_alertchannels

Full name

checkly.checkly_post_v1_alertchannels

Permanently removes an alert channel Official Checkly endpoint: DELETE /v1/alert-channels/{id}.

Lua path

app.integrations.checkly.delete_v1_alertchannels_id

Full name

checkly.checkly_delete_v1_alertchannels_id

Show details of a specific alert channel. Official Checkly endpoint: GET /v1/alert-channels/{id}.

Lua path

app.integrations.checkly.get_v1_alertchannels_id

Full name

checkly.checkly_get_v1_alertchannels_id

Update an alert channel Official Checkly endpoint: PUT /v1/alert-channels/{id}.

Lua path

app.integrations.checkly.put_v1_alertchannels_id

Full name

checkly.checkly_put_v1_alertchannels_id

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

Lua path

app.integrations.checkly.put_v1_alertchannels_id_subscriptions

Full name

checkly.checkly_put_v1_alertchannels_id_subscriptions

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

Lua path

app.integrations.checkly.get_v1_alertnotifications

Full name

checkly.checkly_get_v1_alertnotifications

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

Lua path

app.integrations.checkly.get_v1_analytics_apichecks_id

Full name

checkly.checkly_get_v1_analytics_apichecks_id

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

Lua path

app.integrations.checkly.get_v1_analytics_browserchecks_id

Full name

checkly.checkly_get_v1_analytics_browserchecks_id

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

Lua path

app.integrations.checkly.post_v1_analytics

Full name

checkly.checkly_post_v1_analytics_checks

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

Lua path

app.integrations.checkly.get_v1_analytics_dns_id

Full name

checkly.checkly_get_v1_analytics_dns_id

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

Lua path

app.integrations.checkly.get_v1_analytics_heartbeatchecks_id

Full name

checkly.checkly_get_v1_analytics_heartbeatchecks_id

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

Lua path

app.integrations.checkly.get_v1_analytics_icmp_id

Full name

checkly.checkly_get_v1_analytics_icmp_id

List all available reporting metrics. Official Checkly endpoint: GET /v1/analytics/metrics.

Lua path

app.integrations.checkly.get_v1_analytics_metrics

Full name

checkly.checkly_get_v1_analytics_metrics

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

Lua path

app.integrations.checkly.get_v1_analytics_multistepchecks_id

Full name

checkly.checkly_get_v1_analytics_multistepchecks_id

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

Lua path

app.integrations.checkly.get_v1_analytics_playwrightchecks_id

Full name

checkly.checkly_get_v1_analytics_playwrightchecks_id

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

Lua path

app.integrations.checkly.get_v1_analytics_tcpchecks_id

Full name

checkly.checkly_get_v1_analytics_tcpchecks_id

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

Lua path

app.integrations.checkly.get_v1_analytics_urlmonitors_id

Full name

checkly.checkly_get_v1_analytics_urlmonitors_id

Get check status badge. You can enable the badges feature in account settings Official Checkly endpoint: GET /v1/badges/checks/{checkId}.

Lua path

app.integrations.checkly.get_v1_badges_checkid

Full name

checkly.checkly_get_v1_badges_checks_checkid

Get group status badge. You can enable the badges feature in account settings Official Checkly endpoint: GET /v1/badges/groups/{groupId}.

Lua path

app.integrations.checkly.get_v1_badges_groups_groupid

Full name

checkly.checkly_get_v1_badges_groups_groupid

Cancel a check run, check session, test run, or test session Official Checkly endpoint: POST /v1/cancel.

Lua path

app.integrations.checkly.cancel

Full name

checkly.checkly_cancel

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

Lua path

app.integrations.checkly.get_v1_checkalerts

Full name

checkly.checkly_get_v1_checkalerts

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

Lua path

app.integrations.checkly.get_v1_checkalerts_checkid

Full name

checkly.checkly_get_v1_checkalerts_checkid

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.

Lua path

app.integrations.checkly.get_v1_checkgroups

Full name

checkly.checkly_get_v1_checkgroups

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.

Lua path

app.integrations.checkly.post_v1_checkgroups

Full name

checkly.checkly_post_v1_checkgroups

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}.

Lua path

app.integrations.checkly.get_v1_checkgroups_groupid_checkid

Full name

checkly.checkly_get_v1_checkgroups_groupid_checks_checkid

Permanently removes a check group. You cannot delete a check group if it still contains checks. Official Checkly endpoint: DELETE /v1/check-groups/{id}.

Lua path

app.integrations.checkly.delete_v1_checkgroups_id

Full name

checkly.checkly_delete_v1_checkgroups_id

Show details of a specific check group Official Checkly endpoint: GET /v1/check-groups/{id}.

Lua path

app.integrations.checkly.get_v1_checkgroups_id

Full name

checkly.checkly_get_v1_checkgroups_id

Updates a check group. Official Checkly endpoint: PUT /v1/check-groups/{id}.

Lua path

app.integrations.checkly.put_v1_checkgroups_id

Full name

checkly.checkly_put_v1_checkgroups_id

Lists all checks in a specific check group with the group settings applied. Official Checkly endpoint: GET /v1/check-groups/{id}/checks.

Lua path

app.integrations.checkly.get_v1_checkgroups_id

Full name

checkly.checkly_get_v1_checkgroups_id_checks

[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

Lua path

app.integrations.checkly.get_v1_checkresults_checkid

Full name

checkly.checkly_get_v1_checkresults_checkid

Show details of a specific check result. Official Checkly endpoint: GET /v1/check-results/{checkId}/{checkResultId}.

Lua path

app.integrations.checkly.get_v1_checkresults_checkid_checkresultid

Full name

checkly.checkly_get_v1_checkresults_checkid_checkresultid

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

Lua path

app.integrations.checkly.post_v1_checksessions_trigger

Full name

checkly.checkly_post_v1_checksessions_trigger

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

Lua path

app.integrations.checkly.get_v1_checksessions_checksessionid

Full name

checkly.checkly_get_v1_checksessions_checksessionid

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

Lua path

app.integrations.checkly.get_v1_checksessions_checksessionid_completion

Full name

checkly.checkly_get_v1_checksessions_checksessionid_completion

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.

Lua path

app.integrations.checkly.get_v1_checkstatuses

Full name

checkly.checkly_get_v1_checkstatuses

Show the current status information for a specific check. Official Checkly endpoint: GET /v1/check-statuses/{checkId}.

Lua path

app.integrations.checkly.get_v1_checkstatuses_checkid

Full name

checkly.checkly_get_v1_checkstatuses_checkid

Lists all current checks in your account. Official Checkly endpoint: GET /v1/checks.

Lua path

app.integrations.checkly.get_v1

Full name

checkly.checkly_get_v1_checks

[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

Lua path

app.integrations.checkly.post_v1

Full name

checkly.checkly_post_v1_checks

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.

Lua path

app.integrations.checkly.post_v1_api

Full name

checkly.checkly_post_v1_checks_api

Updates an API check. Official Checkly endpoint: PUT /v1/checks/api/{id}.

Lua path

app.integrations.checkly.put_v1_api_id

Full name

checkly.checkly_put_v1_checks_api_id

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.

Lua path

app.integrations.checkly.post_v1_browser

Full name

checkly.checkly_post_v1_checks_browser

Updates a browser check. Official Checkly endpoint: PUT /v1/checks/browser/{id}.

Lua path

app.integrations.checkly.put_v1_browser_id

Full name

checkly.checkly_put_v1_checks_browser_id

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.

Lua path

app.integrations.checkly.post_v1_dns

Full name

checkly.checkly_post_v1_checks_dns

Updates an DNS monitor. Official Checkly endpoint: PUT /v1/checks/dns/{id}.

Lua path

app.integrations.checkly.put_v1_dns_id

Full name

checkly.checkly_put_v1_checks_dns_id

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.

Lua path

app.integrations.checkly.post_v1_heartbeat

Full name

checkly.checkly_post_v1_checks_heartbeat

Updates a Heartbeat check. Official Checkly endpoint: PUT /v1/checks/heartbeat/{id}.

Lua path

app.integrations.checkly.put_v1_heartbeat_id

Full name

checkly.checkly_put_v1_checks_heartbeat_id

Get heartbeat availability. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/availability.

Lua path

app.integrations.checkly.get_v1_heartbeats_checkid_availability

Full name

checkly.checkly_get_v1_checks_heartbeats_checkid_availability

Get all events from a heartbeat. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/events.

Lua path

app.integrations.checkly.get_v1_heartbeats_checkid_events

Full name

checkly.checkly_get_v1_checks_heartbeats_checkid_events

Get a specific event by its id. Official Checkly endpoint: GET /v1/checks/heartbeats/{checkId}/events/{id}.

Lua path

app.integrations.checkly.get_v1_heartbeats_checkid_events_id

Full name

checkly.checkly_get_v1_checks_heartbeats_checkid_events_id

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.

Lua path

app.integrations.checkly.post_v1_icmp

Full name

checkly.checkly_post_v1_checks_icmp

Updates an ICMP monitor. Official Checkly endpoint: PUT /v1/checks/icmp/{id}.

Lua path

app.integrations.checkly.put_v1_icmp_id

Full name

checkly.checkly_put_v1_checks_icmp_id

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.

Lua path

app.integrations.checkly.post_v1_multistep

Full name

checkly.checkly_post_v1_checks_multistep

Updates a Multi-Step check. Official Checkly endpoint: PUT /v1/checks/multistep/{id}.

Lua path

app.integrations.checkly.put_v1_multistep_id

Full name

checkly.checkly_put_v1_checks_multistep_id

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.

Lua path

app.integrations.checkly.post_v1_tcp

Full name

checkly.checkly_post_v1_checks_tcp

Updates an TCP check. Official Checkly endpoint: PUT /v1/checks/tcp/{id}.

Lua path

app.integrations.checkly.put_v1_tcp_id

Full name

checkly.checkly_put_v1_checks_tcp_id

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.

Lua path

app.integrations.checkly.post_v1_url

Full name

checkly.checkly_post_v1_checks_url

Updates an URL monitor. Official Checkly endpoint: PUT /v1/checks/url/{id}.

Lua path

app.integrations.checkly.put_v1_url_id

Full name

checkly.checkly_put_v1_checks_url_id

Permanently removes a API or browser check and all its related status and results data. Official Checkly endpoint: DELETE /v1/checks/{id}.

Lua path

app.integrations.checkly.delete_v1_id

Full name

checkly.checkly_delete_v1_checks_id

Show details of a specific API or browser check Official Checkly endpoint: GET /v1/checks/{id}.

Lua path

app.integrations.checkly.get_v1_id

Full name

checkly.checkly_get_v1_checks_id

[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}.

Lua path

app.integrations.checkly.put_v1_id

Full name

checkly.checkly_put_v1_checks_id

Lists all client certificates. Official Checkly endpoint: GET /v1/client-certificates.

Lua path

app.integrations.checkly.get_v1_clientcertificates

Full name

checkly.checkly_get_v1_clientcertificates

Creates a new client certificate. Official Checkly endpoint: POST /v1/client-certificates.

Lua path

app.integrations.checkly.post_v1_clientcertificates

Full name

checkly.checkly_post_v1_clientcertificates

Permanently removes a client certificate. Official Checkly endpoint: DELETE /v1/client-certificates/{id}.

Lua path

app.integrations.checkly.delete_v1_clientcertificates_id

Full name

checkly.checkly_delete_v1_clientcertificates_id

Shows one client certificate. Official Checkly endpoint: GET /v1/client-certificates/{id}.

Lua path

app.integrations.checkly.get_v1_clientcertificates_id

Full name

checkly.checkly_get_v1_clientcertificates_id

Lists all current dashboards in your account. Official Checkly endpoint: GET /v1/dashboards.

Lua path

app.integrations.checkly.get_v1_dashboards

Full name

checkly.checkly_get_v1_dashboards

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.

Lua path

app.integrations.checkly.post_v1_dashboards

Full name

checkly.checkly_post_v1_dashboards

Permanently removes a dashboard. Official Checkly endpoint: DELETE /v1/dashboards/{dashboardId}.

Lua path

app.integrations.checkly.delete_v1_dashboards_dashboardid

Full name

checkly.checkly_delete_v1_dashboards_dashboardid

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}.

Lua path

app.integrations.checkly.get_v1_dashboards_dashboardid

Full name

checkly.checkly_get_v1_dashboards_dashboardid

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}.

Lua path

app.integrations.checkly.put_v1_dashboards_dashboardid

Full name

checkly.checkly_put_v1_dashboards_dashboardid

List all error groups in your account. Official Checkly endpoint: GET /v1/error-groups.

Lua path

app.integrations.checkly.get_v1_errorgroups

Full name

checkly.checkly_get_v1_errorgroups

List all error groups for a specific check. Official Checkly endpoint: GET /v1/error-groups/checks/{checkId}.

Lua path

app.integrations.checkly.get_v1_errorgroups_checkid

Full name

checkly.checkly_get_v1_errorgroups_checks_checkid

Retrieve one error group. Official Checkly endpoint: GET /v1/error-groups/{id}.

Lua path

app.integrations.checkly.get_v1_errorgroups_id

Full name

checkly.checkly_get_v1_errorgroups_id

Update an error group. Mainly used for archiving error groups. Official Checkly endpoint: PATCH /v1/error-groups/{id}.

Lua path

app.integrations.checkly.patch_v1_errorgroups_id

Full name

checkly.checkly_patch_v1_errorgroups_id

Creates a new incident. Official Checkly endpoint: POST /v1/incidents.

Lua path

app.integrations.checkly.post_v1_incidents

Full name

checkly.checkly_post_v1_incidents

Permanently removes an incident and all its updates. Official Checkly endpoint: DELETE /v1/incidents/{id}.

Lua path

app.integrations.checkly.delete_v1_incidents_id

Full name

checkly.checkly_delete_v1_incidents_id

Shows details of a specific incident. Uses the "includeAllIncidentUpdates" query parameter to obtain all updates. Official Checkly endpoint: GET /v1/incidents/{id}.

Lua path

app.integrations.checkly.get_v1_incidents_id

Full name

checkly.checkly_get_v1_incidents_id

Updates an incident. Official Checkly endpoint: PUT /v1/incidents/{id}.

Lua path

app.integrations.checkly.put_v1_incidents_id

Full name

checkly.checkly_put_v1_incidents_id

Creates a new update for an incident. Official Checkly endpoint: POST /v1/incidents/{incidentId}/updates.

Lua path

app.integrations.checkly.post_v1_incidents_incidentid_updates

Full name

checkly.checkly_post_v1_incidents_incidentid_updates

Permanently removes an incident update. Official Checkly endpoint: DELETE /v1/incidents/{incidentId}/updates/{id}.

Lua path

app.integrations.checkly.delete_v1_incidents_incidentid_updates_id

Full name

checkly.checkly_delete_v1_incidents_incidentid_updates_id

Modifies an incident update. Official Checkly endpoint: PUT /v1/incidents/{incidentId}/updates/{id}.

Lua path

app.integrations.checkly.put_v1_incidents_incidentid_updates_id

Full name

checkly.checkly_put_v1_incidents_incidentid_updates_id

Lists all supported locationss. Official Checkly endpoint: GET /v1/locations.

Lua path

app.integrations.checkly.get_v1_locations

Full name

checkly.checkly_get_v1_locations

Lists all maintenance windows in your account. Official Checkly endpoint: GET /v1/maintenance-windows.

Lua path

app.integrations.checkly.get_v1_maintenancewindows

Full name

checkly.checkly_get_v1_maintenancewindows

Creates a new maintenance window. Official Checkly endpoint: POST /v1/maintenance-windows.

Lua path

app.integrations.checkly.post_v1_maintenancewindows

Full name

checkly.checkly_post_v1_maintenancewindows

Permanently removes a maintenance window. Official Checkly endpoint: DELETE /v1/maintenance-windows/{id}.

Lua path

app.integrations.checkly.delete_v1_maintenancewindows_id

Full name

checkly.checkly_delete_v1_maintenancewindows_id

Show details of a specific maintenance window. Official Checkly endpoint: GET /v1/maintenance-windows/{id}.

Lua path

app.integrations.checkly.get_v1_maintenancewindows_id

Full name

checkly.checkly_get_v1_maintenancewindows_id

Updates a maintenance window. Official Checkly endpoint: PUT /v1/maintenance-windows/{id}.

Lua path

app.integrations.checkly.put_v1_maintenancewindows_id

Full name

checkly.checkly_put_v1_maintenancewindows_id

Lists all private locations in your account. Official Checkly endpoint: GET /v1/private-locations.

Lua path

app.integrations.checkly.get_v1_privatelocations

Full name

checkly.checkly_get_v1_privatelocations

Creates a new private location. Official Checkly endpoint: POST /v1/private-locations.

Lua path

app.integrations.checkly.post_v1_privatelocations

Full name

checkly.checkly_post_v1_privatelocations

Permanently removes a private location. Official Checkly endpoint: DELETE /v1/private-locations/{id}.

Lua path

app.integrations.checkly.delete_v1_privatelocations_id

Full name

checkly.checkly_delete_v1_privatelocations_id

Show details of a specific private location. Official Checkly endpoint: GET /v1/private-locations/{id}.

Lua path

app.integrations.checkly.get_v1_privatelocations_id

Full name

checkly.checkly_get_v1_privatelocations_id

Updates a private location. Official Checkly endpoint: PUT /v1/private-locations/{id}.

Lua path

app.integrations.checkly.put_v1_privatelocations_id

Full name

checkly.checkly_put_v1_privatelocations_id

Creates an api key on the private location. Official Checkly endpoint: POST /v1/private-locations/{id}/keys.

Lua path

app.integrations.checkly.post_v1_privatelocations_id_keys

Full name

checkly.checkly_post_v1_privatelocations_id_keys

Permanently removes an api key from a private location. Official Checkly endpoint: DELETE /v1/private-locations/{id}/keys/{keyId}.

Lua path

app.integrations.checkly.delete_v1_privatelocations_id_keys_keyid

Full name

checkly.checkly_delete_v1_privatelocations_id_keys_keyid

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.

Lua path

app.integrations.checkly.get_v1_privatelocations_id_metrics

Full name

checkly.checkly_get_v1_privatelocations_id_metrics

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.

Lua path

app.integrations.checkly.get_v1_reporting

Full name

checkly.checkly_get_v1_reporting

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}.

Lua path

app.integrations.checkly.post_v1_rootcauseanalyses_errorgroups_errorgroupid

Full name

checkly.checkly_post_v1_rootcauseanalyses_errorgroups_errorgroupid

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

Lua path

app.integrations.checkly.post_v1_rootcauseanalyses_testsessionerrorgroups_testsessionerrorgroupid

Full name

checkly.checkly_post_v1_rootcauseanalyses_testsessionerrorgroups_testsessionerrorgroupid

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

Lua path

app.integrations.checkly.get_v1_rootcauseanalyses_id

Full name

checkly.checkly_get_v1_rootcauseanalyses_id

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.

Lua path

app.integrations.checkly.get_v1_runtimes

Full name

checkly.checkly_get_v1_runtimes

Shows the details of all included NPM packages and their version for one specific runtime Official Checkly endpoint: GET /v1/runtimes/{id}.

Lua path

app.integrations.checkly.get_v1_runtimes_id

Full name

checkly.checkly_get_v1_runtimes_id

Lists all current snippets in your account. Official Checkly endpoint: GET /v1/snippets.

Lua path

app.integrations.checkly.get_v1_snippets

Full name

checkly.checkly_get_v1_snippets

Creates a new snippet. Official Checkly endpoint: POST /v1/snippets.

Lua path

app.integrations.checkly.post_v1_snippets

Full name

checkly.checkly_post_v1_snippets

Permanently removes a snippet. Official Checkly endpoint: DELETE /v1/snippets/{id}.

Lua path

app.integrations.checkly.delete_v1_snippets_id

Full name

checkly.checkly_delete_v1_snippets_id

Show details of a specific snippet. Official Checkly endpoint: GET /v1/snippets/{id}.

Lua path

app.integrations.checkly.get_v1_snippets_id

Full name

checkly.checkly_get_v1_snippets_id

Updates a snippet. Official Checkly endpoint: PUT /v1/snippets/{id}.

Lua path

app.integrations.checkly.put_v1_snippets_id

Full name

checkly.checkly_put_v1_snippets_id

Lists all source IPs for check runs as a single JSON array. Official Checkly endpoint: GET /v1/static-ips.

Lua path

app.integrations.checkly.get_v1_staticips

Full name

checkly.checkly_get_v1_staticips

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.

Lua path

app.integrations.checkly.get_v1_staticipsbyregion

Full name

checkly.checkly_get_v1_staticipsbyregion

Lists all IPs for check runs as a TXT file. Each line has one IP. Official Checkly endpoint: GET /v1/static-ips.txt.

Lua path

app.integrations.checkly.get_v1_staticipstxt

Full name

checkly.checkly_get_v1_staticipstxt

Lists all source IPv6s for check runs as a single JSON array. Official Checkly endpoint: GET /v1/static-ipv6s.

Lua path

app.integrations.checkly.get_v1_staticipv6s

Full name

checkly.checkly_get_v1_staticipv6s

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.

Lua path

app.integrations.checkly.get_v1_staticipv6sbyregion

Full name

checkly.checkly_get_v1_staticipv6sbyregion

Lists all IPv6s for check runs as a TXT file. Each line has one IP. Official Checkly endpoint: GET /v1/static-ipv6s.txt.

Lua path

app.integrations.checkly.get_v1_staticipv6stxt

Full name

checkly.checkly_get_v1_staticipv6stxt

Get all status pages for an account. Official Checkly endpoint: GET /v1/status-pages.

Lua path

app.integrations.checkly.get_v1_statuspages

Full name

checkly.checkly_get_v1_statuspages

Create a new status page with its related services and cards. Official Checkly endpoint: POST /v1/status-pages.

Lua path

app.integrations.checkly.post_v1_statuspages

Full name

checkly.checkly_post_v1_statuspages

Get the latest 100 incidents for all services. Official Checkly endpoint: GET /v1/status-pages/incidents.

Lua path

app.integrations.checkly.get_v1_statuspages_incidents

Full name

checkly.checkly_get_v1_statuspages_incidents

Creates a new incident. Official Checkly endpoint: POST /v1/status-pages/incidents.

Lua path

app.integrations.checkly.post_v1_statuspages_incidents

Full name

checkly.checkly_post_v1_statuspages_incidents

Permanently removes an incident and all its updates. Official Checkly endpoint: DELETE /v1/status-pages/incidents/{incidentId}.

Lua path

app.integrations.checkly.delete_v1_statuspages_incidents_incidentid

Full name

checkly.checkly_delete_v1_statuspages_incidents_incidentid

Get incident details including incident history and affected services. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}.

Lua path

app.integrations.checkly.get_v1_statuspages_incidents_incidentid

Full name

checkly.checkly_get_v1_statuspages_incidents_incidentid

Updates an incident. Official Checkly endpoint: PUT /v1/status-pages/incidents/{incidentId}.

Lua path

app.integrations.checkly.put_v1_statuspages_incidents_incidentid

Full name

checkly.checkly_put_v1_statuspages_incidents_incidentid

Lists all updates for a specific incident. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}/incident-updates.

Lua path

app.integrations.checkly.get_v1_statuspages_incidents_incidentid_incidentupdates

Full name

checkly.checkly_get_v1_statuspages_incidents_incidentid_incidentupdates

Creates a new update for an incident. Official Checkly endpoint: POST /v1/status-pages/incidents/{incidentId}/incident-updates.

Lua path

app.integrations.checkly.post_v1_statuspages_incidents_incidentid_incidentupdates

Full name

checkly.checkly_post_v1_statuspages_incidents_incidentid_incidentupdates

Permanently removes an incident update. Official Checkly endpoint: DELETE /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}.

Lua path

app.integrations.checkly.delete_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Full name

checkly.checkly_delete_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Shows details of a specific incident update. Official Checkly endpoint: GET /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}.

Lua path

app.integrations.checkly.get_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Full name

checkly.checkly_get_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Modifies an incident update. Official Checkly endpoint: PUT /v1/status-pages/incidents/{incidentId}/incident-updates/{incidentUpdateId}.

Lua path

app.integrations.checkly.put_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Full name

checkly.checkly_put_v1_statuspages_incidents_incidentid_incidentupdates_incidentupdateid

Get all services Official Checkly endpoint: GET /v1/status-pages/services.

Lua path

app.integrations.checkly.get_v1_statuspages_services

Full name

checkly.checkly_get_v1_statuspages_services

Create a service Official Checkly endpoint: POST /v1/status-pages/services.

Lua path

app.integrations.checkly.post_v1_statuspages_services

Full name

checkly.checkly_post_v1_statuspages_services

Delete a service Official Checkly endpoint: DELETE /v1/status-pages/services/{serviceId}.

Lua path

app.integrations.checkly.delete_v1_statuspages_services_serviceid

Full name

checkly.checkly_delete_v1_statuspages_services_serviceid

Get a single service Official Checkly endpoint: GET /v1/status-pages/services/{serviceId}.

Lua path

app.integrations.checkly.get_v1_statuspages_services_serviceid

Full name

checkly.checkly_get_v1_statuspages_services_serviceid

Update a service Official Checkly endpoint: PUT /v1/status-pages/services/{serviceId}.

Lua path

app.integrations.checkly.put_v1_statuspages_services_serviceid

Full name

checkly.checkly_put_v1_statuspages_services_serviceid

Delete a status page. Official Checkly endpoint: DELETE /v1/status-pages/{statusPageId}.

Lua path

app.integrations.checkly.delete_v1_statuspages_statuspageid

Full name

checkly.checkly_delete_v1_statuspages_statuspageid

Get status page data, including cards and services. Official Checkly endpoint: GET /v1/status-pages/{statusPageId}.

Lua path

app.integrations.checkly.get_v1_statuspages_statuspageid

Full name

checkly.checkly_get_v1_statuspages_statuspageid

Update a status page with its related services and cards. Official Checkly endpoint: PUT /v1/status-pages/{statusPageId}.

Lua path

app.integrations.checkly.put_v1_statuspages_statuspageid

Full name

checkly.checkly_put_v1_statuspages_statuspageid

Get all subscriptions for a specific status page Official Checkly endpoint: GET /v1/status-pages/{statusPageId}/subscriptions.

Lua path

app.integrations.checkly.get_v1_statuspages_statuspageid_subscriptions

Full name

checkly.checkly_get_v1_statuspages_statuspageid_subscriptions

Bulk create subscriptions for a specific status page. Official Checkly endpoint: POST /v1/status-pages/{statusPageId}/subscriptions/bulk.

Lua path

app.integrations.checkly.post_v1_statuspages_statuspageid_subscriptions_bulk

Full name

checkly.checkly_post_v1_statuspages_statuspageid_subscriptions_bulk

Delete a subscription belonging to a specific status page using the subscription id Official Checkly endpoint: DELETE /v1/status-pages/{statusPageId}/subscriptions/{subscriptionId}.

Lua path

app.integrations.checkly.delete_v1_statuspages_statuspageid_subscriptions_subscriptionid

Full name

checkly.checkly_delete_v1_statuspages_statuspageid_subscriptions_subscriptionid

List all test session error groups in your account. Official Checkly endpoint: GET /v1/test-session-error-groups.

Lua path

app.integrations.checkly.get_v1_testsessionerrorgroups

Full name

checkly.checkly_get_v1_testsessionerrorgroups

List all test session error groups for a specific project. Official Checkly endpoint: GET /v1/test-session-error-groups/projects/{projectId}.

Lua path

app.integrations.checkly.get_v1_testsessionerrorgroups_projects_projectid

Full name

checkly.checkly_get_v1_testsessionerrorgroups_projects_projectid

Retrieve one test session error group. Official Checkly endpoint: GET /v1/test-session-error-groups/{id}.

Lua path

app.integrations.checkly.get_v1_testsessionerrorgroups_id

Full name

checkly.checkly_get_v1_testsessionerrorgroups_id

Update a test session error group. Mainly used for archiving test session error groups. Official Checkly endpoint: PATCH /v1/test-session-error-groups/{id}.

Lua path

app.integrations.checkly.patch_v1_testsessionerrorgroups_id

Full name

checkly.checkly_patch_v1_testsessionerrorgroups_id

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/

Lua path

app.integrations.checkly.post_v1_testsessions_trigger

Full name

checkly.checkly_post_v1_testsessions_trigger

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}.

Lua path

app.integrations.checkly.get_v1_testsessions_testsessionid

Full name

checkly.checkly_get_v1_testsessions_testsessionid

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

Lua path

app.integrations.checkly.get_v1_testsessions_testsessionid_completion

Full name

checkly.checkly_get_v1_testsessions_testsessionid_completion

[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}.

Lua path

app.integrations.checkly.delete_v1_triggers_checkgroups_groupid

Full name

checkly.checkly_delete_v1_triggers_checkgroups_groupid

[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}.

Lua path

app.integrations.checkly.get_v1_triggers_checkgroups_groupid

Full name

checkly.checkly_get_v1_triggers_checkgroups_groupid

[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}.

Lua path

app.integrations.checkly.post_v1_triggers_checkgroups_groupid

Full name

checkly.checkly_post_v1_triggers_checkgroups_groupid

[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}.

Lua path

app.integrations.checkly.delete_v1_triggers_checkid

Full name

checkly.checkly_delete_v1_triggers_checks_checkid

[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}.

Lua path

app.integrations.checkly.get_v1_triggers_checkid

Full name

checkly.checkly_get_v1_triggers_checks_checkid

[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}.

Lua path

app.integrations.checkly.post_v1_triggers_checkid

Full name

checkly.checkly_post_v1_triggers_checks_checkid

Lists all current environment variables in your account. Official Checkly endpoint: GET /v1/variables.

Lua path

app.integrations.checkly.get_v1_variables

Full name

checkly.checkly_get_v1_variables

Creates a new environment variable. Official Checkly endpoint: POST /v1/variables.

Lua path

app.integrations.checkly.post_v1_variables

Full name

checkly.checkly_post_v1_variables

Permanently removes an environment variable. Uses the "key" field as the ID for deletion. Official Checkly endpoint: DELETE /v1/variables/{key}.

Lua path

app.integrations.checkly.delete_v1_variables_key

Full name

checkly.checkly_delete_v1_variables_key

Show details of a specific environment variable. Uses the "key" field for selection. Official Checkly endpoint: GET /v1/variables/{key}.

Lua path

app.integrations.checkly.get_v1_variables_key

Full name

checkly.checkly_get_v1_variables_key

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}.

Lua path

app.integrations.checkly.put_v1_variables_key

Full name

checkly.checkly_put_v1_variables_key

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.

Lua path

app.integrations.checkly.post_v2_checkgroups

Full name

checkly.checkly_post_v2_checkgroups

Updates a check group. Official Checkly endpoint: PUT /v2/check-groups/{id}.

Lua path

app.integrations.checkly.put_v2_checkgroups_id

Full name

checkly.checkly_put_v2_checkgroups_id

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

Lua path

app.integrations.checkly.get_v2_checkresults_checkid

Full name

checkly.checkly_get_v2_checkresults_checkid

Trigger a new check session Official Checkly endpoint: POST /v2/check-sessions/trigger.

Lua path

app.integrations.checkly.post_v2_checksessions_trigger

Full name

checkly.checkly_post_v2_checksessions_trigger

Retrieve a check session Official Checkly endpoint: GET /v2/check-sessions/{checkSessionId}.

Lua path

app.integrations.checkly.get_v2_checksessions_checksessionid

Full name

checkly.checkly_get_v2_checksessions_checksessionid

Await the completion of a check session Official Checkly endpoint: GET /v2/check-sessions/{checkSessionId}/completion.

Lua path

app.integrations.checkly.get_v2_checksessions_checksessionid_completion

Full name

checkly.checkly_get_v2_checksessions_checksessionid_completion