> ## Documentation Index
> Fetch the complete documentation index at: https://docs.atako.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Checkly

> Connect Checkly to your Atako agents — 18 read and 1 write actions.

Let your agents follow the status of your Checkly checks, read check and group definitions, alert channels and dashboards (secrets removed), read their latest results and alerts, run checks on demand, and read reports, maintenance windows and status pages.

## Connection

* **Authentication**: API key (User API key).
* **Required settings**:
  * **Account ID** — UUID of your Checkly account, e.g. a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d — Account Settings → General.

<Note>
  In Checkly, open User Settings → API keys → Create API key, name it and copy the key right away (it is shown only once). The key inherits the access level of your user ("read only" or "admin"). The Account ID is under Account Settings → General.

  See [Checkly's documentation](https://app.checklyhq.com/settings/user/api-keys).
</Note>

## Read actions (18)

| Action | Description |
| - | - |
| `get_check` | Get one check definition (same fields as list\_checks, secrets removed). Required: id (check UUID, see list\_checks or list\_check\_statuses). Optional: includeDependencies (boolean), applyGroupSettings (boolean: return the check with its group settings applied). |
| `get_check_group` | Get one check group (same fields as list\_check\_groups, secrets removed). Required: id (integer group ID, see list\_check\_groups). |
| `get_check_session` | Get a check session started by trigger\_check\_session: status (STARTED, PROGRESS, PASSED, FAILED, DEGRADED, TIMED\_OUT, CANCELLED…), run locations, elapsed time and one summary per result (hasFailures, hasErrors, isDegraded, responseTime). |
| `get_check_status` | Get the current status of one check (hasFailures, hasErrors, isDegraded, longest/shortest run, last run location). |
| `get_maintenance_window` | Get one maintenance window by its ID (integer, see list\_maintenance\_windows). |
| `get_report` | Aggregated statistics per check (successRatio, avg, p95, p99 response times) over a window. Optional: quickRange (last24Hrs default, last7Days, last30Days, thisWeek, thisMonth, lastWeek, lastMonth) or from / to (UNIX timestamps in seconds, as strings, override quickRange), filterByTags (array of tag strings), deactivated (boolean: true = only deactivated checks, false = only active ones), granularity (day, week, month: one aggregate per bucket), timezone (IANA name, e.g. "Europe/Paris", used with granularity). |
| `get_status_page` | Get one status page by its UUID (see list\_status\_pages). |
| `list_alert_channels` | List alert channels: id, type (EMAIL, SLACK, SLACK\_APP, WEBHOOK, SMS, PAGERDUTY, OPSGENIE, CALL), subscriptions (checkId / groupId, activated), sendRecovery, sendFailure, sendDegraded, sslExpiry, autoSubscribe. The channel config (URLs, keys, addresses) is removed. Optional: limit (1–100, default 10), page (from 1). |
| `list_check_alerts` | List the alerts sent for the account within a 6-hour window (default: the last 6 hours): check name, checkId, alertType, runLocation, error, statusCode. Optional: from / to (UNIX timestamps in seconds, as strings, at most 6 hours apart), limit (1–100, default 10), page (from 1). |
| `list_check_alerts_for_check` | List the alerts sent for one check within a 6-hour window (default: the last 6 hours). Optional: from / to (UNIX timestamps in seconds, as strings, at most 6 hours apart), limit (1–100, default 10), page (from 1). |
| `list_check_groups` | List check groups: id (integer), name, activated, muted, tags, locations, concurrency, runtimeId, apiCheckDefaults (url, assertions — no headers, query parameters nor basic auth), environment variable keys (values removed), alertChannelSubscriptions. Optional: limit (1–100, default 10), page (from 1), tag (array of tag strings, any match), name (array of exact group names). |
| `list_check_results` | List the latest raw results of one check (kept 30 days): id, runLocation, hasFailures, hasErrors, isDegraded, responseTime, startedAt, stoppedAt, attempts, resultType, errorGroupIds. Request/response payloads are never returned. Optional filters: limit (1–100, default 10), location (e.g. "eu-west-1"), checkType, hasFailures (boolean), resultType ("FINAL" default, "ATTEMPT" or "ALL"), from / to (UNIX timestamps in seconds, numbers), nextId (cursor returned by the previous page). Rate limit: 60 requests per minute. |
| `list_check_statuses` | List the current status of every check in the account (name, checkId, hasFailures, hasErrors, isDegraded, last run location, SSL days remaining). Use it to find check UUIDs. |
| `list_checks` | List check definitions: id, name, checkType, activated, muted, frequency, locations, tags, groupId, request (method, url, bodyType, assertions — no headers, query parameters, body nor basic auth), script, alertChannelSubscriptions, environment variable keys (values removed), heartbeat period (ping token removed). Optional: limit (1–100, default 10), page (from 1), search (name, partial match), checkType (API, BROWSER, HEARTBEAT, MULTI\_STEP, TCP, PLAYWRIGHT, URL, DNS, SSL, ICMP, TRACEROUTE, GRPC, AGENTIC), status (passing, failing, degraded), tag (array of tag strings, any match), apiCheckUrlFilterPattern (string contained in an API check URL), applyGroupSettings (boolean). |
| `list_dashboards` | List dashboards: dashboardId, header, customUrl, customDomain, tags, isPrivate, refreshRate, paginate and display settings. Private dashboard keys are removed. Optional: limit (1–100, default 10), page (from 1). |
| `list_locations` | List the public data-center locations checks can run from (region code, e.g. "eu-west-1", and name). |
| `list_maintenance_windows` | List maintenance windows (name, tags, startsAt, endsAt, repeat rule, timezone, whether checks are paused or alerts silenced). Optional: limit (1–100, default 10), page (from 1). |
| `list_status_pages` | List the status pages of the account (name, url, custom domain, private or public). Optional: limit (1–100, default 20), nextId (cursor returned by the previous page). |

## Write actions (1)

| Action | Description |
| - | - |
| `trigger_check_session` | Run checks now (the "Schedule Now" button); alerting rules apply to the finished runs and each run counts toward your Checkly usage. Arguments: target: object, REQUIRED here with at least one of checkId: array of check UUID strings (see list\_check\_statuses) or matchTags: array of arrays of tag strings (each inner array is one tag group, e.g. \[\["production","api"]]). refreshCache: optional boolean (default false). Returns sessions\[] with a checkSessionId per check — follow them with get\_check\_session. |

## Permissions

Every action above must be explicitly granted to an agent before it can be used. See [Permissions](/integrations/permissions) for the grant model and [Security](/integrations/security) for how credentials are protected.

***

*Last reviewed against the provider API: September 2026.*


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.