Checkly

Retrieve the Checkly account this connection acts on, with its plan and default runtime. Use this to confirm which ac…

List every Checkly account this API key can reach. Use get_current_account for just the account the connection is con…

List the people with access to the current Checkly account, with their roles. Use this to find the user IDs and email…

List the destinations Checkly sends alerts to, such as email, Slack and webhooks. Use this before subscribing a check…

Retrieve one alert channel by ID, with its type-specific config. Use list_alert_channels to find channel IDs.

Create an alert destination. The config keys depend on type: EMAIL takes address, SLACK and WEBHOOK take url, SMS and…

Update an alert channel’s config or which alert kinds it receives. Checkly applies a partial update, so fields you om…

Permanently delete an alert channel. Checks subscribed to it stop sending alerts there. Use list_alert_channels to fi…

List alerts Checkly has raised across every check, newest first, optionally limited to a date range. Use this to revi…

List check groups, which hold shared locations, runtime and alert settings for a set of checks. Filter by tag or by e…

Retrieve one check group by ID, with its shared settings. Use list_check_groups to find group IDs.

List the checks that belong to one check group. Use list_check_groups to find group IDs. Returns page_info.next_page …

Create a check group so several checks share locations, runtime and alert settings. Use list_locations for location c…

Update a check group. Checkly applies a partial update, so fields you omit keep their current values. Use list_check_…

Permanently delete a check group. Checks in the group are not deleted; they lose the group’s shared settings. Use lis…

List recorded runs of one check, newest first, filtered by location, failure state, result type and time window. Defa…

Retrieve one recorded check run in full, including timings and per-assertion detail. Use list_check_results to find r…

List monitoring checks, newest first, with server-side filtering by type, name, tag, status and API-check URL. Use th…

Retrieve one check by ID, including its schedule, locations and request or heartbeat configuration. Use list_checks t…

Create an API check that sends an HTTP request on a schedule and asserts on the response. Needs locations unless grou…

Create a heartbeat check that alerts when a scheduled job stops pinging Checkly. The response carries the ping URL th…

Update a check. Checkly applies a partial update, so fields you omit keep their current values. Use list_checks for c…

Permanently delete a check and its run history. Use list_checks to find check IDs. This cannot be undone.

List maintenance windows, the scheduled periods in which Checkly pauses checks and silences their alerts. Use get_mai…

Retrieve one maintenance window by ID, with its schedule and the tags it applies to. Use list_maintenance_windows to …

Create a maintenance window so checks are paused and alerts silenced during planned work. Scope it to checks carrying…

Update a maintenance window’s schedule or the tags it applies to. Checkly applies a partial update, so fields you omi…

Permanently delete a maintenance window, so the checks it covered are no longer paused during it. Use list_maintenanc…

List the public locations Checkly can run checks from. Call this before create_api_check or create_check_group to get…

List the runtime versions checks can execute on, with their Node.js version and bundled packages. Call this before cr…

Retrieve one runtime by ID, including every package version it bundles. Use list_runtimes to find valid runtime IDs.

List the IPv4 addresses Checkly’s public runners send traffic from, for allowlisting a monitored endpoint’s firewall.

Get aggregated success rates and response-time percentiles per check over a window. Pass quick_range for a preset win…

List reusable JavaScript snippets that checks can run as setup or teardown steps. Use this to find a snippet ID befor…

Retrieve one snippet by ID, including its full script. Use list_snippets to find snippet IDs.

Create a reusable JavaScript snippet that checks can run as a setup or teardown step. Returns the new snippet’s id.

Update a snippet’s name or script. Checkly applies a partial update, so fields you omit keep their current values. Us…

Permanently delete a snippet. Checks that reference it will fail until they are updated. Use list_snippets to find sn…

List account-level environment variables that checks can read at runtime. Use this to find a variable key before read…

Retrieve one environment variable by key. Variables stored as secrets come back without their value. Use list_variabl…

Create an account-level environment variable that checks can read at runtime. The key is the identifier and cannot be…

Replace an environment variable’s value. The key itself cannot be changed; delete and recreate the variable to rename…

Permanently delete an environment variable. Checks that read it will fail until they are updated. Use list_variables …