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

# Checkly

> Read Checkly checks, check results, and current statuses

## At a glance

* **Availability**: Experimental ([how to enable](/cloud/integrations)).
* **Auth**: API key.
* **Connection**: The key comes from `CHECKLY_API_KEY`.
* **Docs**: [https://www.checklyhq.com/docs/api-reference/overview/](https://www.checklyhq.com/docs/api-reference/overview/)

## Credentials

Set these per environment. See [Connect an integration](/cloud/integrations).

| Variable             | Required | Description                                                                                                               |
| -------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------- |
| `CHECKLY_API_KEY`    | Yes      | Checkly user API key [Docs](https://www.checklyhq.com/docs/api-reference/overview/).                                      |
| `CHECKLY_ACCOUNT_ID` | Yes      | Checkly account ID (sent as the X-Checkly-Account header) [Docs](https://www.checklyhq.com/docs/api-reference/overview/). |

## Setup

1. **Sign up for Checkly**: Create a free account at [https://app.checklyhq.com](https://app.checklyhq.com) (the free Hobby plan includes API access) and create at least one check.
2. **Create an API key**: Go to User Settings → API keys ([https://app.checklyhq.com/settings/user/api-keys](https://app.checklyhq.com/settings/user/api-keys)), create a key, and add it to your .env as CHECKLY\_API\_KEY.
3. **Copy your account ID**: Find the account ID under Account Settings → General and add it as CHECKLY\_ACCOUNT\_ID.
4. **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

Provider API reference: [https://www.checklyhq.com/docs/api-reference/overview/](https://www.checklyhq.com/docs/api-reference/overview/)

## 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.