Checkly
Synthetic monitoring and API checks — manage checks, check groups, alert channels, maintenance windows, snippets and environment variables, and read run results and reporting.
Categories: Monitoring, Observability, Developer Tools
What you can ask
- 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/healthevery 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.
Set up
Checkly connects with credentials from your Checkly account. Have these values ready:
- Account ID
- API key
- Go to Organization > Connectors and find Checkly.
- Click Enable and choose which tools to allow.
- Each member enters their own values the first time they use it.
To use one account for the whole organization, turn on Share one connection with everyone. Every member's agents then act as that account, with exactly the access it has.
Tools
Checkly offers 44 tools. Admins choose which ones agents can use. See Tool permission groups.
Read (25)
View and search information without changing it.
| Tool | What it does |
|---|---|
get_alert_channel | Retrieve one alert channel by ID, with its type-specific config. |
get_check | Retrieve one check by ID, including its schedule, locations and request or heartbeat configuration. |
get_check_group | Retrieve one check group by ID, with its shared settings. |
get_check_result | Retrieve one recorded check run in full, including timings and per-assertion detail. |
get_current_account | Retrieve the Checkly account this connection acts on, with its plan and default runtime. |
get_maintenance_window | Retrieve one maintenance window by ID, with its schedule and the tags it applies to. |
get_reporting | Get aggregated success rates and response-time percentiles per check over a window. |
get_runtime | Retrieve one runtime by ID, including every package version it bundles. |
get_snippet | Retrieve one snippet by ID, including its full script. |
get_variable | Retrieve one environment variable by key. |
list_account_members | List the people with access to the current Checkly account, with their roles. |
list_accounts | List every Checkly account this API key can reach. |
list_alert_channels | List the destinations Checkly sends alerts to, such as email, Slack and webhooks. |
list_check_alerts | List alerts Checkly has raised across every check, newest first, optionally limited to a date range. |
list_check_group_checks | List the checks that belong to one check group. |
list_check_groups | List check groups, which hold shared locations, runtime and alert settings for a set of checks. |
list_check_results | List recorded runs of one check, newest first, filtered by location, failure state, result type and time window. |
list_checks | List monitoring checks, newest first, with server-side filtering by type, name, tag, status and API-check URL. |
list_locations | List the public locations Checkly can run checks from. |
list_maintenance_windows | List maintenance windows, the scheduled periods in which Checkly pauses checks and silences their alerts. |
list_runtimes | List the runtime versions checks can execute on, with their Node.js version and bundled packages. |
list_snippets | List reusable JavaScript snippets that checks can run as setup or teardown steps. |
list_static_ips | List the IPv4 addresses Checkly's public runners send traffic from, for allowlisting a monitored endpoint's firewall. |
list_variables | List account-level environment variables that checks can read at runtime. |
validate_credential | Validate the Checkly API key and account ID with a lightweight account lookup. |
Write (7)
Create or send data.
| Tool | What it does |
|---|---|
create_alert_channel | Create an alert destination. |
create_api_check | Create an API check that sends an HTTP request on a schedule and asserts on the response. |
create_check_group | Create a check group so several checks share locations, runtime and alert settings. |
create_heartbeat_check | Create a heartbeat check that alerts when a scheduled job stops pinging Checkly. |
create_maintenance_window | Create a maintenance window so checks are paused and alerts silenced during planned work. |
create_snippet | Create a reusable JavaScript snippet that checks can run as a setup or teardown step. |
create_variable | Create an account-level environment variable that checks can read at runtime. |
Delete or overwrite (12)
Remove or replace existing data.
| Tool | What it does |
|---|---|
delete_alert_channel | Permanently delete an alert channel. |
delete_check | Permanently delete a check and its run history. |
delete_check_group | Permanently delete a check group. |
delete_maintenance_window | Permanently delete a maintenance window, so the checks it covered are no longer paused during it. |
delete_snippet | Permanently delete a snippet. |
delete_variable | Permanently delete an environment variable. |
update_alert_channel | Update an alert channel's config or which alert kinds it receives. |
update_check | Update a check. |
update_check_group | Update a check group. |
update_maintenance_window | Update a maintenance window's schedule or the tags it applies to. |
update_snippet | Update a snippet's name or script. |
update_variable | Replace an environment variable's value. |