# Checkly Docs: API Reference ## API Reference ### Getting Started - [Using the Checkly API](https://www.checklyhq.com/docs/api-reference/overview.md): Use the Checkly Public API to manage monitoring resources, retrieve account information, and export analytics. ### API Reference #### Accounts - [Get details for all accounts](https://www.checklyhq.com/docs/api-reference/accounts/fetch-user-accounts.md): List account details based on supplied API key. - [Get details for the current account](https://www.checklyhq.com/docs/api-reference/accounts/fetch-current-account-details.md): Get details from the current account. - [Get details for a specific account](https://www.checklyhq.com/docs/api-reference/accounts/fetch-a-given-account-details.md): Get details from a specific account. - [Fetch current account entitlements](https://www.checklyhq.com/docs/api-reference/accounts/fetch-current-account-entitlements.md): Fetch the entitlements for the account, including feature access and limits based on the current plan. - [Fetch account entitlements](https://www.checklyhq.com/docs/api-reference/accounts/fetch-account-entitlements.md): Fetch the entitlements for the account, including feature access and limits based on the current plan. - [List current account members and pending invites](https://www.checklyhq.com/docs/api-reference/accounts/list-current-account-members-and-pending-invites.md) - [List account members and pending invites](https://www.checklyhq.com/docs/api-reference/accounts/list-account-members-and-pending-invites.md) - [Remove a current account member](https://www.checklyhq.com/docs/api-reference/accounts/remove-a-current-account-member.md) - [Update a current account member role](https://www.checklyhq.com/docs/api-reference/accounts/update-a-current-account-member-role.md) - [Remove an account member](https://www.checklyhq.com/docs/api-reference/accounts/remove-an-account-member.md) - [Update an account member role](https://www.checklyhq.com/docs/api-reference/accounts/update-an-account-member-role.md) #### Alert Channels - [List all alert channels](https://www.checklyhq.com/docs/api-reference/alert-channels/list-all-alert-channels.md): Lists all configured alert channels and their subscribed checks. - [Create an alert channel](https://www.checklyhq.com/docs/api-reference/alert-channels/create-an-alert-channel.md): Creates a new alert channel - [Retrieve an alert channel](https://www.checklyhq.com/docs/api-reference/alert-channels/retrieve-an-alert-channel.md): Show details of a specific alert channel. - [Update an alert channel](https://www.checklyhq.com/docs/api-reference/alert-channels/update-an-alert-channel.md): Update an alert channel - [Delete an alert channel](https://www.checklyhq.com/docs/api-reference/alert-channels/delete-an-alert-channel.md): Permanently removes an alert channel - [Update the subscriptions of an alert channel](https://www.checklyhq.com/docs/api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel.md): 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. #### Alert Notifications - [Lists all alert notifications](https://www.checklyhq.com/docs/api-reference/alert-notifications/lists-all-alert-notifications.md): Lists the alert notifications that have been sent for your account. You can filter by alert channel ID or limit to only failing notifications. #### Analytics - [API checks](https://www.checklyhq.com/docs/api-reference/analytics/api-checks.md): 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. - [Browser checks](https://www.checklyhq.com/docs/api-reference/analytics/browser-checks.md): 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 cal… - [Multistep checks](https://www.checklyhq.com/docs/api-reference/analytics/multistep-checks.md): 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.** - [Playwright checks](https://www.checklyhq.com/docs/api-reference/analytics/playwright-checks.md): 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.** - [DNS monitors](https://www.checklyhq.com/docs/api-reference/analytics/dns-monitors.md): 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. - [Heartbeat monitors](https://www.checklyhq.com/docs/api-reference/analytics/heartbeat-checks.md): 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 30 requests / 60 seconds at most.** - [TCP monitors](https://www.checklyhq.com/docs/api-reference/analytics/tcp-checks.md): 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. - [URL monitors](https://www.checklyhq.com/docs/api-reference/analytics/url-monitors.md): 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. - [List all available reporting metrics.](https://www.checklyhq.com/docs/api-reference/analytics/list-all-available-reporting-metrics.md): List all available reporting metrics. - [ICMP monitors](https://www.checklyhq.com/docs/api-reference/analytics/icmp-monitors.md): 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. - [Get analytics summary for multiple checks](https://www.checklyhq.com/docs/api-reference/analytics/get-analytics-summary-for-multiple-checks.md): 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 means the metric does not apply to that… - [SSL monitors](https://www.checklyhq.com/docs/api-reference/analytics/ssl-monitors.md): Fetch detailed availability metrics and aggregated or non-aggregated SSL Monitor metrics across custom time ranges. For example, you can get the p99 and p95 of the TLS handshake time together with the availability percentage for any time range. #### Badges - [Get badge for a check](https://www.checklyhq.com/docs/api-reference/badges/get-v1badgeschecks.md): Get check status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general) - [Get badge for a group](https://www.checklyhq.com/docs/api-reference/badges/get-v1badgesgroups.md): Get group status badge. You can enable the badges feature in [account settings](https://app.checklyhq.com/settings/account/general) #### Checks and Monitors - [List all checks](https://www.checklyhq.com/docs/api-reference/checks/list-all-checks.md): Lists all current checks in your account. - [List all checks (v3)](https://www.checklyhq.com/docs/api-reference/checks/list-all-checks-v3.md): Lists all current checks in your account. - [List all checks (v2)](https://www.checklyhq.com/docs/api-reference/checks/list-all-checks-v2.md): Lists all current checks in your account. - [Retrieve a check](https://www.checklyhq.com/docs/api-reference/checks/retrieve-a-check.md): Show details of a specific API or browser check - [Retrieve a check (v3)](https://www.checklyhq.com/docs/api-reference/checks/retrieve-a-check-v3.md): Show details of a specific API or browser check. - [Retrieve a check (v2)](https://www.checklyhq.com/docs/api-reference/checks/retrieve-a-check-v2.md): Show details of a specific API or browser check. - [Delete a check](https://www.checklyhq.com/docs/api-reference/checks/delete-a-check.md): Permanently removes a API or browser check and all its related status and results data. - [Create a check](https://www.checklyhq.com/docs/api-reference/checks/create-a-check.md): 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` can be `null` - [Update a check](https://www.checklyhq.com/docs/api-reference/checks/update-a-check.md): Updates an API or browser check. - [Create an SSL monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-an-ssl-monitor.md): Creates a new SSL monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` - [Update an SSL Monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-an-ssl-monitor.md): Updates an SSL monitor. - [Create a Traceroute monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-a-traceroute-monitor.md): Creates a new Traceroute monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` - [Update a Traceroute Monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-a-traceroute-monitor.md): Updates a Traceroute monitor. - [Create a gRPC monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-a-grpc-monitor.md): Creates a new gRPC monitor. Will return a `402` when you are over the limit of your plan. When using the `globalAlertSetting`, the `alertSetting` can be `null` - [Update a gRPC Monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-a-grpc-monitor.md): Updates a gRPC monitor. ##### API Check - [Create an API check](https://www.checklyhq.com/docs/api-reference/checks/create-an-api-check.md): 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` - [Update an API check](https://www.checklyhq.com/docs/api-reference/checks/update-an-api-check.md): Updates an API check. ##### Browser Check - [Create a browser check](https://www.checklyhq.com/docs/api-reference/checks/create-a-browser-check.md): 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` - [Update a browser check](https://www.checklyhq.com/docs/api-reference/checks/update-a-browser-check.md): Updates a browser check. ##### Multistep Check - [Create a multi-step check](https://www.checklyhq.com/docs/api-reference/checks/create-a-multi-step-check.md): 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` - [Update a multi-step check](https://www.checklyhq.com/docs/api-reference/checks/update-a-multi-step-check.md): Updates a Multi-Step check. ##### DNS Monitor - [Create an DNS monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-a-dns-monitor.md): 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` - [Update an DNS Monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-a-dns-monitor.md): Updates an DNS monitor. ##### Heartbeat Monitor - [Create a heartbeat monitor](https://www.checklyhq.com/docs/api-reference/heartbeats/create-a-heartbeat-check.md): 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` - [Update a heartbeat monitor](https://www.checklyhq.com/docs/api-reference/heartbeats/update-a-heartbeat-check.md): Updates a Heartbeat check. - [Get heartbeat monitor availability](https://www.checklyhq.com/docs/api-reference/heartbeats/get-heartbeat-availability.md): Get heartbeat availability. - [List all events for a heartbeat monitor](https://www.checklyhq.com/docs/api-reference/heartbeats/get-a-list-of-events-for-a-heartbeat.md): Get all events from a heartbeat. - [List a specific event for a heartbeat monitor](https://www.checklyhq.com/docs/api-reference/heartbeats/get-a-specific-heartbeat-event.md): Get a specific event by its id. ##### TCP Monitor - [Create a TCP monitor](https://www.checklyhq.com/docs/api-reference/checks/create-a-tcp-check.md): 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` - [Update a TCP monitor](https://www.checklyhq.com/docs/api-reference/checks/update-an-tcp-check.md): Updates an TCP check. ##### URL Monitor - [Create a URL monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-a-url-monitor.md): 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` - [Update a URL monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-an-url-monitor.md): Updates an URL monitor. ##### ICMP Monitor - [Create an ICMP monitor](https://www.checklyhq.com/docs/api-reference/monitors/create-an-icmp-monitor.md): 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` - [Update an ICMP Monitor](https://www.checklyhq.com/docs/api-reference/monitors/update-an-icmp-monitor.md): Updates an ICMP monitor. #### Check Alerts - [List all alerts for your account](https://www.checklyhq.com/docs/api-reference/check-alerts/list-all-alerts-for-your-account.md): Lists all alerts that have been sent for your account. - [List alerts for a specific check](https://www.checklyhq.com/docs/api-reference/check-alerts/list-alerts-for-a-specific-check.md): Lists all the alerts for a specific check. #### Check Groups - [List all check groups](https://www.checklyhq.com/docs/api-reference/check-groups/list-all-check-groups.md): 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. - [Retrieve a check group](https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-a-check-group.md): Show details of a specific check group - [Delete a check group.](https://www.checklyhq.com/docs/api-reference/check-groups/delete-a-check-group.md): Permanently removes a check group. You cannot delete a check group if it still contains checks. - [Retrieve one check in a specific group with group settings applied](https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied.md): Show details of one check in a specific check group with the group settings applied. - [Retrieve one check in a specific group with group settings applied (V2)](https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied-v2.md): Show details of one check in a specific check group with the group settings applied. - [Retrieve all checks in a specific group with group settings applied](https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied.md): Lists all checks in a specific check group with the group settings applied. - [Retrieve all checks in a specific group with group settings applied (V2)](https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied-v2.md): Lists all checks in a specific check group with the group settings applied. - [Create a check group](https://www.checklyhq.com/docs/api-reference/check-groups/create-a-check-group.md): Creates a new check group. You can add checks to the group by setting the "groupId" property of individual checks. - [Create a check group (V2)](https://www.checklyhq.com/docs/api-reference/check-groups/create-a-check-group-v2.md): Creates a new check group. You can add checks to the group by setting the "groupId" property of individual checks. - [Update a check group](https://www.checklyhq.com/docs/api-reference/check-groups/update-a-check-group.md): Updates a check group. - [Update a check group (V2)](https://www.checklyhq.com/docs/api-reference/check-groups/update-a-check-group-v2.md): Updates a check group. #### Check Results - [Lists all check results](https://www.checklyhq.com/docs/api-reference/check-results/lists-all-check-results.md): 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. - [Retrieve a check result](https://www.checklyhq.com/docs/api-reference/check-results/retrieve-a-check-result.md): Show details of a specific check result. - [Lists all check results](https://www.checklyhq.com/docs/api-reference/check-results/lists-all-check-results-1.md): 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. - [Retrieve a normalized asset manifest for a check result](https://www.checklyhq.com/docs/api-reference/check-results/retrieve-a-normalized-asset-manifest-for-a-check-result.md): Returns a normalized manifest of downloadable assets for the check result. #### Check Sessions - [Trigger a new check session](https://www.checklyhq.com/docs/api-reference/check-sessions/trigger-a-new-check-session.md): Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks. - [Trigger a new check session (v2)](https://www.checklyhq.com/docs/api-reference/check-sessions/trigger-a-new-check-session-v2.md): Starts a check session for each check that matches the provided target filters. If no filters are given, matches all eligible checks. - [Retrieve a check session](https://www.checklyhq.com/docs/api-reference/check-sessions/retrieve-a-check-session.md): Retrieves a check session. Results may be incomplete if the check session is still in progress. - [Retrieve a check session (v2)](https://www.checklyhq.com/docs/api-reference/check-sessions/retrieve-a-check-session-v2.md): Retrieves a check session. Results may be incomplete if the check session is still in progress. - [Await the completion of a check session](https://www.checklyhq.com/docs/api-reference/check-sessions/await-the-completion-of-a-check-session.md): 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). - [Await the completion of a check session (v2)](https://www.checklyhq.com/docs/api-reference/check-sessions/await-the-completion-of-a-check-session-v2.md): Call this endpoint to await the completion of a check session. A successful response will be returned once the check session reaches its final state (i.e. when it passes, fails, degrades, or is cancelled). - [Cancel a check session](https://www.checklyhq.com/docs/api-reference/check-sessions/cancel-a-check-session.md): Cancels in-progress Playwright Check Suite runs within the specified check session. Use the optional `sequenceId` field in the request body to cancel only specific parallel runs within the session; omit it to cancel everything still running. #### Check Status - [List all check statuses](https://www.checklyhq.com/docs/api-reference/check-status/list-all-check-statuses.md): Shows the current status information for all checks in your account. The check status records are continuously updated as new check results come in. - [Retrieve check status details](https://www.checklyhq.com/docs/api-reference/check-status/retrieve-check-status-details.md): Show the current status information for a specific check. #### Check Triggers - [Get the check group trigger](https://www.checklyhq.com/docs/api-reference/triggers/get-the-check-group-trigger.md): Finds the check group trigger - [Create the check group trigger](https://www.checklyhq.com/docs/api-reference/triggers/create-the-check-group-trigger.md): Creates the check group trigger - [Delete the check group trigger](https://www.checklyhq.com/docs/api-reference/triggers/delete-the-check-group-trigger.md): Deletes the check groups trigger - [Get the check trigger](https://www.checklyhq.com/docs/api-reference/triggers/get-the-check-trigger.md): Finds the check trigger. - [Create the check trigger](https://www.checklyhq.com/docs/api-reference/triggers/create-the-check-trigger.md): Creates the check trigger - [Delete the check trigger](https://www.checklyhq.com/docs/api-reference/triggers/delete-the-check-trigger.md): Deletes the check trigger #### Client Certificates - [List all client certificates](https://www.checklyhq.com/docs/api-reference/client-certificates/lists-all-client-certificates.md): Lists all current client certificates in your account. - [Create a client certificate](https://www.checklyhq.com/docs/api-reference/client-certificates/creates-a-new-client-certificate.md): Creates a new client certificate. Be sure to extract the certificate and private key from your PEM files so the string retains any line break, i.e. "\n" characters. - [Retrieve a client certificate](https://www.checklyhq.com/docs/api-reference/client-certificates/shows-one-client-certificate.md): Shows details of a specific client certificate. Note, we do not show the passphrase property for security reasons. - [Delete a client certificate](https://www.checklyhq.com/docs/api-reference/client-certificates/deletes-a-client-certificate.md): Permanently removes a client certificate. #### Dashboards - [List all dashboards](https://www.checklyhq.com/docs/api-reference/dashboards/list-all-dashboards.md): Lists all current dashboards in your account. - [Create a dashboard](https://www.checklyhq.com/docs/api-reference/dashboards/create-a-dashboard.md): 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. - [Retrieve a dashboard](https://www.checklyhq.com/docs/api-reference/dashboards/retrieve-a-dashboard.md): Show details of a specific dashboard. - [Update a dashboard](https://www.checklyhq.com/docs/api-reference/dashboards/update-a-dashboard.md): Updates a dashboard. Will return a 409 when attempting to create a dashboard with a custom URL or custom domain that is already taken. - [Delete a dashboard](https://www.checklyhq.com/docs/api-reference/dashboards/delete-a-dashboard.md): Permanently removes a dashboard. #### Dashboard Incidents - [Create an incident](https://www.checklyhq.com/docs/api-reference/incidents/create-an-incident.md): Creates a new incident. - [Retrieve an incident](https://www.checklyhq.com/docs/api-reference/incidents/retrieve-an-incident.md): Shows details of a specific incident. Uses the "includeAllIncidentUpdates" query parameter to obtain all updates. - [Update an incident](https://www.checklyhq.com/docs/api-reference/incidents/update-an-incident.md): Updates an incident. - [Delete an incident](https://www.checklyhq.com/docs/api-reference/incidents/delete-an-incident.md): Permanently removes an incident and all its updates. #### Dashboard Incident Updates - [Create an incident update](https://www.checklyhq.com/docs/api-reference/incident-updates/create-an-incident-update.md): Creates a new update for an incident. - [Update an incident update](https://www.checklyhq.com/docs/api-reference/incident-updates/update-an-incident-update.md): Modifies an incident update. - [Delete an incident update](https://www.checklyhq.com/docs/api-reference/incident-updates/delete-an-incident-update.md): Permanently removes an incident update. #### Error Groups - [List all error groups in your account.](https://www.checklyhq.com/docs/api-reference/error-groups/list-all-error-groups.md): List all error groups in your account. - [List all error groups for a specific check.](https://www.checklyhq.com/docs/api-reference/error-groups/list-all-error-groups-for-a-specific-check.md): List all error groups for a specific check. - [Retrieve one error group.](https://www.checklyhq.com/docs/api-reference/error-groups/retrieve-an-error-group.md): Retrieve one error group. - [Update an error group](https://www.checklyhq.com/docs/api-reference/error-groups/update-an-error-group.md): Update an error group. Mainly used for archiving error groups. #### Environment Variables - [List all environment variables](https://www.checklyhq.com/docs/api-reference/environment-variables/list-all-environment-variables.md): Lists all current environment variables in your account. - [Create an environment variable](https://www.checklyhq.com/docs/api-reference/environment-variables/create-an-environment-variable.md): Creates a new environment variable. - [Retrieve an environment variable](https://www.checklyhq.com/docs/api-reference/environment-variables/retrieve-an-environment-variable.md): Show details of a specific environment variable. Uses the "key" field for selection. - [Update an environment variable](https://www.checklyhq.com/docs/api-reference/environment-variables/update-an-environment-variable.md): 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. - [Delete an environment variable](https://www.checklyhq.com/docs/api-reference/environment-variables/delete-an-environment-variable.md): Permanently removes an environment variable. Uses the "key" field as the ID for deletion. #### Locations - [Lists all supported locations](https://www.checklyhq.com/docs/api-reference/location/lists-all-supported-locations.md): Lists all supported locationss. #### Maintenance Windows - [List all maintenance windows](https://www.checklyhq.com/docs/api-reference/maintenance-windows/list-all-maintenance-windows.md): Lists all maintenance windows in your account. - [Create a maintenance window](https://www.checklyhq.com/docs/api-reference/maintenance-windows/create-a-maintenance-window.md): Creates a new maintenance window. Status-page-only fields live under `statusPageVisibility` and only take effect when `statusPageVisibility.enabled: true`. - [Retrieve a maintenance window](https://www.checklyhq.com/docs/api-reference/maintenance-windows/retrieve-a-maintenance-window.md): Show details of a specific maintenance window. - [Update a maintenance window](https://www.checklyhq.com/docs/api-reference/maintenance-windows/update-a-maintenance-window.md): Partially updates a maintenance window. Only fields included in the request body are modified; omitted fields are left unchanged. Status-page-only fields live under `statusPageVisibility` and only take effect when `statusPageVisibility.enabled: true`. - [Delete a maintenance window](https://www.checklyhq.com/docs/api-reference/maintenance-windows/delete-a-maintenance-window.md): Permanently removes a maintenance window. - [List maintenances for a maintenance window](https://www.checklyhq.com/docs/api-reference/maintenance-windows/list-maintenances-for-a-maintenance-window.md) - [Delete a maintenance](https://www.checklyhq.com/docs/api-reference/maintenance-windows/delete-a-maintenance.md) - [Retrieve a maintenance](https://www.checklyhq.com/docs/api-reference/maintenance-windows/retrieve-a-maintenance.md) - [Update maintenance dates](https://www.checklyhq.com/docs/api-reference/maintenance-windows/update-maintenance-dates.md) - [Create a maintenance window status update](https://www.checklyhq.com/docs/api-reference/maintenance-windows/create-a-maintenance-window-status-update.md): Creates a new status update for a status-page-visible maintenance window. - [Delete a maintenance window status update](https://www.checklyhq.com/docs/api-reference/maintenance-windows/delete-a-maintenance-window-status-update.md): Permanently removes a status update from a maintenance window. - [Update a maintenance window status update](https://www.checklyhq.com/docs/api-reference/maintenance-windows/update-a-maintenance-window-status-update.md): Updates a status update for a status-page-visible maintenance window. #### Private Locations - [List all private locations](https://www.checklyhq.com/docs/api-reference/private-locations/list-all-private-locations.md): Lists all private locations in your account. - [Create a private location](https://www.checklyhq.com/docs/api-reference/private-locations/create-a-private-location.md): Creates a new private location. - [Retrieve a private location](https://www.checklyhq.com/docs/api-reference/private-locations/retrieve-a-private-location.md): Show details of a specific private location. - [Update a private location](https://www.checklyhq.com/docs/api-reference/private-locations/update-a-private-location.md): Updates a private location. - [Remove a private location](https://www.checklyhq.com/docs/api-reference/private-locations/remove-a-private-location.md): Permanently removes a private location. - [Generate a new API Key for a private location](https://www.checklyhq.com/docs/api-reference/private-locations/generate-a-new-api-key-for-a-private-location.md): Creates an api key on the private location. - [Remove an existing API key for a private location](https://www.checklyhq.com/docs/api-reference/private-locations/remove-an-existing-api-key-for-a-private-location.md): Permanently removes an api key from a private location. - [Get private location health metrics from a window of time.](https://www.checklyhq.com/docs/api-reference/private-locations/get-private-location-health-metrics-from-a-window-of-time.md): Get private location health metrics from a window of time. #### Reporting - [Generate report](https://www.checklyhq.com/docs/api-reference/reporting/generates-a-report-with-aggregate-statistics-for-checks-and-check-groups.md): Generates a report with aggregated statistics for all checks or a filtered set of checks over a specified time window. #### Rocky AI - [Retrieve a Root Cause Analysis](https://www.checklyhq.com/docs/api-reference/rocky-ai/retrieve-one-root-cause-analysis.md): Retrieves a specific root cause analysis. Use the `id` returned from either POST endpoint and poll until the response is HTTP 200. While the analysis is being generated the endpoint returns HTTP 202 with `{"id":"","status":"PENDING"}`. A genuine HTTP 404 means the ID does not exist. Works for… - [Generate a Root Cause Analysis for a check error group](https://www.checklyhq.com/docs/api-reference/rocky-ai/generate-a-root-cause-analysis-for-an-error-group.md): 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. - [Generate a Root Cause Analysis for a test session error group](https://www.checklyhq.com/docs/api-reference/rocky-ai/generate-a-root-cause-analysis-for-a-test-session-error-group.md): 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. #### Runtimes - [List all supported runtimes](https://www.checklyhq.com/docs/api-reference/runtimes/lists-all-supported-runtimes.md): Lists all supported runtimes and the included NPM packages for Browser checks and setup & teardown scripts for API checks. - [List details for a runtime](https://www.checklyhq.com/docs/api-reference/runtimes/shows-details-for-one-specific-runtime.md): Shows the details of all included NPM packages and their version for one specific runtime #### Usage - [Usage API](https://www.checklyhq.com/docs/api-reference/usage/overview.md): Get usage terms, totals, projections, and time-series data for an organization. - [Get usage terms](https://www.checklyhq.com/docs/api-reference/usage/get-usage-terms.md): Get usage terms and accounts for an organization. - [Get usage summary](https://www.checklyhq.com/docs/api-reference/usage/get-usage-summary.md): Get usage totals and contract projections for a date range. - [Get usage series](https://www.checklyhq.com/docs/api-reference/usage/get-usage-series.md): Get paginated usage grouped by time, account, or check type. - [Get usage terms v2](https://www.checklyhq.com/docs/api-reference/usage/get-usage-terms-and-accounts-for-the-current-organization.md): List all usage terms, optionally filtered by inclusive UTC dates. Results are live and paginated. - [Get usage series v2](https://www.checklyhq.com/docs/api-reference/usage/get-paginated-consumption-across-usage-terms-group-by-account-usage-term-pricing-rule-and-check-type.md): Get paginated consumption across usage terms. Group by account, usage term, pricing rule and check type. - [Get usage summary v2](https://www.checklyhq.com/docs/api-reference/usage/get-consumption-across-usage-terms-with-a-calculation-breakdown-for-each-pricing-rule.md): Get consumption across usage terms, with a calculation breakdown for each pricing rule. - [Get usage term v2](https://www.checklyhq.com/docs/api-reference/usage/get-a-usage-term-with-its-budget-accounts-and-applied-pricing-rules.md): Get a usage term with its budget, accounts and applied pricing rules. - [Get usage projections v2](https://www.checklyhq.com/docs/api-reference/usage/project-whole-term-credit-consumption-from-completed-utc-days-using-v2-pricing-rules.md): Project whole-term credit consumption from completed UTC days using v2 pricing rules. #### Static IPs - [List IPs for check runs](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ips-for-check-runs.md): Lists all source IPs for check runs as a single JSON array. - [List IPs for check runs by region](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ips-for-check-runs-1.md): Lists all source IPs for check runs as object with regions as keys and an array of IPs as value. - [List IPs for check runs as a TXT file](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ips-for-check-runs-as-txt-file.md): Lists all IPs for check runs as a TXT file. Each line has one IP. - [List IPv6s for check runs](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs.md): Lists all source IPv6s for check runs as a single JSON array. - [List IPv6s for check runs by region](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-1.md): Lists all source IPs for check runs as an object with regions as keys and an Ipv6 as value. - [List IPv6s for check runs as a TXT file](https://www.checklyhq.com/docs/api-reference/static-ips/lists-all-source-ipv6s-for-check-runs-as-a-txt-file.md): Lists all IPv6s for check runs as a TXT file. Each line has one IP. #### Status Pages - [List v3 status pages.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-v3-status-pages.md): List the v3 (components-based) status pages of an account. v2 pages are served by /v1/status-pages. - [Create a new v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/create-a-new-v3-status-page.md): Create a new v3 status page. Add components afterwards via the components endpoints. - [Retrieve a single v3 status page by id.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-a-single-v3-status-page-by-id.md): Get a v3 (components-based) status page. Components and automation rules have their own endpoints. - [Update an existing v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-an-existing-v3-status-page.md): Update a v3 status page. This is a full replacement: omitted optional fields are reset. - [Delete a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-a-v3-status-page.md): Delete a v3 status page together with its components and automation rules. - [Retrieve custom domain verification details for a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-custom-domain-verification-details-for-a-v3-status-page.md): Get DNS records for verification purposes related to your custom domain. - [Re-check the custom domain verification of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/re-check-the-custom-domain-verification-of-a-v3-status-page.md): Ask Cloudflare to re-check the custom domain verification and return the latest state. #### Status Page Components - [List the components of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-the-components-of-a-v3-status-page.md): List the components of a v3 status page in display order. - [Create a component on a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/create-a-component-on-a-v3-status-page.md): Add a SERVICE or GROUP component to a v3 status page. Nest it under a GROUP via parentId. - [Retrieve a single component of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-a-single-component-of-a-v3-status-page.md): Get a single component of a v3 status page. - [Update a component of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-a-component-of-a-v3-status-page.md): Update a component. This is a full replacement: omitted optional fields are reset. - [Delete a component of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-a-component-of-a-v3-status-page.md): Delete a component. Child components are detached from it, not deleted. #### Status Page Automation Rules - [List the automation rules of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-the-automation-rules-of-a-v3-status-page.md): List the automation rules of a v3 status page, newest first. - [Create an automation rule on a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/create-an-automation-rule-on-a-v3-status-page.md): Create an automation rule. A failing check whose tags (or group tags) overlap with the rule tags opens one incident impacting the listed components. - [Retrieve a single automation rule of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-a-single-automation-rule-of-a-v3-status-page.md): Get a single automation rule. - [Update an automation rule of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-an-automation-rule-of-a-v3-status-page.md): Update an automation rule. The component list is replaced as a whole. - [Delete an automation rule of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-an-automation-rule-of-a-v3-status-page.md): Delete an automation rule. An incident it opened stays. #### Status Page Incidents - [List the incidents of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-the-incidents-of-a-v3-status-page.md): List the incidents of a v3 status page, most recently updated first. - [Open an incident on a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/open-an-incident-on-a-v3-status-page.md): Open an incident on a v3 status page with its first update and the current status of the impacted components. - [Retrieve an incident of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-an-incident-of-a-v3-status-page.md): Get an incident of a v3 status page, including its updates and component impacts. - [Update an incident of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/update-an-incident-of-a-v3-status-page.md): Rename an incident and/or reconcile the current status of its components. Post progress through the incident-updates endpoints. - [Delete an incident of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-an-incident-of-a-v3-status-page.md): Permanently remove an incident and all its updates. - [Replace an incident's component impact timeline.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/replace-an-incidents-component-impact-timeline.md): Replace the full impact timeline of an incident with explicit per-component windows (retroactive editing). #### Status Page Incident Updates - [List the updates of an incident.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-the-updates-of-an-incident.md): List the updates of an incident, newest first (at most 100). - [Post an update to an incident.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/post-an-update-to-an-incident.md): Post an update to an incident. A RESOLVED update closes the incident. - [Retrieve an incident update.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/retrieve-an-incident-update.md): Get a single incident update. - [Edit an incident update.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/edit-an-incident-update.md): Edit an incident update. - [Delete an incident update.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-an-incident-update.md): Delete an incident update. The last remaining update cannot be deleted. #### Status Page Subscribers - [List the subscribers of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/list-the-subscribers-of-a-v3-status-page.md): List the email subscribers of a v3 status page, newest first. - [Subscribe multiple email addresses to a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/subscribe-multiple-email-addresses-to-a-v3-status-page.md): Subscribe up to 100 email addresses at once. Each subscriber can be limited to specific components via config.subscribedComponents; addresses already subscribed are skipped. - [Delete a subscriber of a v3 status page.](https://www.checklyhq.com/docs/api-reference/status-pages-v3/delete-a-subscriber-of-a-v3-status-page.md): Remove a subscriber from a v3 status page. #### Status Pages v1 - [Retrieve all status pages.](https://www.checklyhq.com/docs/api-reference/status-pages/retrieve-all-status-pages.md): Get all status pages for an account. - [Create a new status page.](https://www.checklyhq.com/docs/api-reference/status-pages/create-a-new-status-page.md): Create a new status page with its related services and cards. - [Retrieve a single status page by id.](https://www.checklyhq.com/docs/api-reference/status-pages/retrieve-a-single-status-page-by-id.md): Get status page data, including cards and services. - [Update an existing status page.](https://www.checklyhq.com/docs/api-reference/status-pages/update-an-existing-status-page.md): Update a status page with its related services and cards. - [Delete a status page.](https://www.checklyhq.com/docs/api-reference/status-pages/delete-a-status-page.md): Delete a status page. #### Status Page Incidents v1 - [Retrieve the latest incidents with pagination.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/retrieve-the-latest-incidents-with-pagination.md): Get the latest 100 incidents for all services. - [Create a new incident.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/create-a-new-incident.md): Creates a new incident. - [Retrieve an incident by id.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/retrieve-an-incident-by-id.md): Get incident details including incident history and affected services. - [Update an existing incident.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/update-an-existing-incident.md): Updates an incident. - [Delete an incident.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/delete-an-incident.md): Permanently removes an incident and all its updates. #### Status Page Incident Updates v1 - [Retrieve the 100 latest incident updates of a specific incident.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/retrieve-the-100-latest-incident-updates-of-a-specific-incident.md): Lists all updates for a specific incident. - [Add a new incident update to a specific incident.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/add-a-new-incident-update-to-a-specific-incident.md): Creates a new update for an incident. - [Retrieve an incident update by id.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/retrieve-an-incident-update-by-id.md): Shows details of a specific incident update. - [Update an existing incident update.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/update-an-existing-incident-update.md): Modifies an incident update. - [Delete an incident update.](https://www.checklyhq.com/docs/api-reference/status-page-incidents/delete-an-incident-update.md): Permanently removes an incident update. #### Status Page Services v1 - [Get all services](https://www.checklyhq.com/docs/api-reference/status-page-services/get-all-services.md): Get all services - [Create a service](https://www.checklyhq.com/docs/api-reference/status-page-services/create-a-service.md): Create a service - [Get a single service](https://www.checklyhq.com/docs/api-reference/status-page-services/get-a-single-service.md): Get a single service - [Update a service](https://www.checklyhq.com/docs/api-reference/status-page-services/update-a-service.md): Update a service - [Delete a service](https://www.checklyhq.com/docs/api-reference/status-page-services/delete-a-service.md): Delete a service #### Status Page Subscribers v1 - [Get all subscriptions for a specific status page](https://www.checklyhq.com/docs/api-reference/status-pages/get-all-subscriptions-for-a-specific-status-page.md): Get all subscriptions for a specific status page - [Bulk create subscriptions for a specific status page](https://www.checklyhq.com/docs/api-reference/status-pages/bulk-create-subscriptions-for-a-specific-status-page.md): Bulk create subscriptions for a specific status page. - [Delete a subscription belonging to a specific status page](https://www.checklyhq.com/docs/api-reference/status-pages/delete-a-subscription-belonging-to-a-specific-status-page.md): Delete a subscription belonging to a specific status page using the subscription id #### Test Sessions - [List test sessions](https://www.checklyhq.com/docs/api-reference/test-sessions/list-test-sessions.md): Retrieves test sessions for the selected account. Use the optional query parameters to filter by creation time, status, branch, user, provider, text, or error group. - [Trigger a new test session](https://www.checklyhq.com/docs/api-reference/test-sessions/trigger-a-new-test-session.md): Starts a tests session with checks matching the provided target filters. If no filters are given, matches all eligible checks. - [Retrieve a test session](https://www.checklyhq.com/docs/api-reference/test-sessions/retrieve-a-test-session.md): Retrieves a test session. Note that the returned data may be incomplete if the test session is still in progress. - [Await the completion of a test session](https://www.checklyhq.com/docs/api-reference/test-sessions/await-the-completion-of-a-test-session.md): 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). - [Cancel a test session](https://www.checklyhq.com/docs/api-reference/test-sessions/cancel-a-test-session.md): Cancels in-progress Playwright runs within the specified test session. Use the optional `sequenceId` field in the request body to cancel only specific results within the session; omit it to cancel everything still running. - [Retrieve a test session result](https://www.checklyhq.com/docs/api-reference/test-sessions/retrieve-a-test-session-result.md): Retrieves detailed data for a single result within a test session, including check-type details and uploaded asset references when available. - [Retrieve a normalized asset manifest for a test-session result](https://www.checklyhq.com/docs/api-reference/test-sessions/retrieve-a-normalized-asset-manifest-for-a-test-session-result.md): Returns a normalized manifest of downloadable assets for the test-session result. #### Test Session Error Groups - [List all test session error groups](https://www.checklyhq.com/docs/api-reference/test-session-error-groups/list-all-test-session-error-groups.md) - [List all test session error groups for a specific project.](https://www.checklyhq.com/docs/api-reference/test-session-error-groups/list-all-test-session-error-groups-for-a-project.md): List all test session error groups for a specific project. - [Retrieve one test session error group.](https://www.checklyhq.com/docs/api-reference/test-session-error-groups/retrieve-a-test-session-error-group.md): Retrieve one test session error group. - [Update an error group](https://www.checklyhq.com/docs/api-reference/test-session-error-groups/update-a-test-session-error-group.md): Update a test session error group. Mainly used for archiving test session error groups. #### Deployment Triggers - [List deployment triggers](https://www.checklyhq.com/docs/api-reference/deployment-triggers/list-all-deployment-triggers.md): List the GitHub deployment triggers configured for your Checkly account. - [Create a deployment trigger](https://www.checklyhq.com/docs/api-reference/deployment-triggers/create-a-deployment-trigger.md): Create a GitHub deployment trigger for a Checkly check or check group. #### Secret scans - [Lists readable configuration values that look like inline credentials.](https://www.checklyhq.com/docs/api-reference/secret-scans/lists-readable-configuration-values-that-look-like-inline-credentials.md): Scans the account's checks (request headers, query parameters, basic auth, URLs, bodies, gRPC metadata, scripts, environment variables), check groups, snippets, alert channels, integrations, and account environment variables for readable values that look like credentials stored inline. Locked and se… ## OpenAPI Specs - [openapi](/docs/api-reference/openapi.json)