At a glance
- Availability: Experimental (how to enable).
- Auth: API key.
- Connection: The key comes from
CHECKLY_API_KEY. - Docs: https://www.checklyhq.com/docs/api-reference/overview/
Credentials
Set these per environment. See Connect an integration.Setup
- Sign up for Checkly: Create a free account at https://app.checklyhq.com (the free Hobby plan includes API access) and create at least one check.
- Create an API key: Go to User Settings → API keys (https://app.checklyhq.com/settings/user/api-keys), create a key, and add it to your .env as CHECKLY_API_KEY.
- Copy your account ID: Find the account ID under Account Settings → General and add it as CHECKLY_ACCOUNT_ID.
- Verify access: Run List Checks, then List Check Statuses.
- Every request needs both ‘Authorization: Bearer <api key>’ and the ‘X-Checkly-Account: <account id>’ header
- Raw check results are kept for 30 days, and a results query window (from/to) may span at most 6 hours
- Check results use the newer /v2 path; checks and statuses use /v1
Tools
| Tool | Access | Description |
|---|---|---|
| List Checks | Read | List API and browser checks in the account |
| Get Check | Read | Get a check’s full configuration |
| List Check Results | Read | List raw results for a check within a time window (from/to must be at most 6 hours apart) |
| List Check Statuses | Read | Get the current status of every check in the account |
| Get Check Status | Read | Get the current status of a single check |
Example prompts
- List my Checkly check statuses and tell me which checks are currently failing or degraded.
- Get the results with failures for my main Checkly check over the last 6 hours and summarize the errors.