> This page is for Workforce.

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.merge.dev/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.merge.dev/_mcp/server.

# Checkly

**Authentication:** API key. See [Magic Link](/merge-agent-handler/features/magic-link) for the runtime auth flow.

## Sample use cases

* List every check that failed in the last 24 hours and the locations it failed from.
* Create an API check that hits `https://api.acme.com/health` every 5 minutes and alerts the on-call Slack channel.
* Schedule a maintenance window for Saturday 02:00 to 04:00 UTC covering the checkout check group.

## Available Tools

#### get_current_account

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

#### list_accounts

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

#### list_account_members

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

#### list_alert_channels

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

#### get_alert_channel

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

#### create_alert_channel

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

#### update_alert_channel

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

#### delete_alert_channel

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

#### list_check_alerts

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

#### list_check_groups

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

#### get_check_group

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

#### list_check_group_checks

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

#### create_check_group

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

#### update_check_group

Update a check group. Checkly applies a partial update, so fields you omit keep their current values. Use list_check\_...

#### delete_check_group

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

#### list_check_results

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

#### get_check_result

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

#### list_checks

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

#### get_check

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

#### create_api_check

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

#### create_heartbeat_check

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

#### update_check

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

#### delete_check

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

#### list_maintenance_windows

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

#### get_maintenance_window

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

#### create_maintenance_window

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

#### update_maintenance_window

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

#### delete_maintenance_window

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

#### list_locations

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

#### list_runtimes

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

#### get_runtime

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

#### list_static_ips

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

#### get_reporting

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

#### list_snippets

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

#### get_snippet

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

#### create_snippet

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

#### update_snippet

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

#### delete_snippet

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

#### list_variables

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

#### get_variable

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

#### create_variable

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

#### update_variable

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

#### delete_variable

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