Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
2 changes: 1 addition & 1 deletion admin/changing-your-email-password.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Changing your email or password in Checkly"
description: "Learn how to change your email address or password in your Checkly account"
sidebarTitle: "Changing Email or Password"
sidebarTitle: "Changing email or password"
canonical: 'https://www.checklyhq.com/docs/admin/changing-your-email-password/'
---

Expand Down
2 changes: 1 addition & 1 deletion admin/creating-api-key.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Creating an API key in Checkly"
description: "Learn how to create and manage user and service API keys for the Checkly API and CLI"
sidebarTitle: "Creating an API Key"
sidebarTitle: "Creating an API key"
canonical: 'https://www.checklyhq.com/docs/admin/creating-api-key/'
---

Expand Down
2 changes: 1 addition & 1 deletion admin/deleting-your-account.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Deleting your Checkly account"
description: "Learn how to permanently delete your Checkly account"
sidebarTitle: "Deleting Your Account"
sidebarTitle: "Deleting your account"
canonical: 'https://www.checklyhq.com/docs/admin/deleting-your-account/'
---

Expand Down
2 changes: 1 addition & 1 deletion admin/security-and-compliance.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Security, privacy and compliance"
description: "Find Checkly's SOC 2 and GDPR information, how to request the SOC 2 report and other compliance documents, where the Terms cover the Data Processing Addendum, the privacy policy, and how to report a security issue or delete your account"
sidebarTitle: "Security and Compliance"
sidebarTitle: "Security and compliance"
canonical: 'https://www.checklyhq.com/docs/admin/security-and-compliance/'
---

Expand Down
2 changes: 1 addition & 1 deletion admin/team-management/adding-team-members.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Adding team members to your Checkly account"
description: "Learn how to invite team members to join your Checkly account and manage team collaboration"
sidebarTitle: "Adding Team Members"
sidebarTitle: "Adding team members"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/adding-team-members/'
---

Expand Down
4 changes: 2 additions & 2 deletions admin/team-management/custom-roles.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Custom roles"
description: "Beta documentation for creating custom roles and assigning them to members, invitations, and service API keys."
sidebarTitle: "Custom Roles"
sidebarTitle: "Custom roles"
tag: "Beta"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/custom-roles/'
---
Expand All @@ -12,7 +12,7 @@ Custom roles are in beta and are not generally available. This documentation app

A custom role is a named set of permissions that you pick one by one. Custom roles sit next to the [built-in roles](/admin/team-management/overview#team-member-roles). You can assign them to members, invitations, and [service API keys](/admin/creating-api-key#service-api-keys).

## The Roles page
## The roles page

**Account settings > Roles** lists your account's custom roles. It shows once custom roles are turned on for your account. Each row has the role's name and description, how many permissions it grants, and how many members, pending invitations, and service API keys hold it. Click a role's name to open it.

Expand Down
2 changes: 1 addition & 1 deletion admin/team-management/managing-team-members.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Managing team members"
description: "Find members in your Checkly account, change their roles or remove them several at a time, resend or remove pending invitations, change your own role, and leave an account."
sidebarTitle: "Managing Team Members"
sidebarTitle: "Managing team members"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/managing-team-members/'
---

Expand Down
4 changes: 2 additions & 2 deletions admin/team-management/multi-factor-authentication.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Multi-Factor Authentication in Checkly"
title: "Multi-factor authentication in Checkly"
description: "Learn how to set up and manage multi-factor authentication for enhanced account security"
sidebarTitle: "Multi-Factor Auth"
sidebarTitle: "Multi-factor auth"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/multi-factor-authentication/'
---

Expand Down
26 changes: 13 additions & 13 deletions admin/team-management/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
---
title: "Admin Overview"
title: "Admin overview"
description: "Comprehensive guide to managing your Checkly account, team members, security, and integrations"
sidebarTitle: "Overview"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/overview/'
---

This section covers all aspects of administering your Checkly account, from managing team members and permissions to setting up advanced security features and API access.

## Team Member Roles
## Team member roles

Checkly has five built-in roles: **Owner**, **Admin**, **Read & Write**, **Read & Run**, and **Read Only**. Each role inherits all permissions from the roles below it. If [custom roles](/admin/team-management/custom-roles) (beta) are enabled for your account, you can also define roles with the permissions you pick.

Expand Down Expand Up @@ -36,7 +36,7 @@ Each account has one Owner. The account creator is the Owner until they [transfe

Your account role grants permissions for actions on resources. Use the [permissions reference](/admin/team-management/permissions) to find each permission’s ID, name in the role editor, description, and how to request access.

### Choosing the Right Role
### Choosing the right role

| Role | Best for |
|------|----------|
Expand All @@ -46,19 +46,19 @@ Your account role grants permissions for actions on resources. Use the [permissi
| **Read & Run** | QA engineers or CI/CD pipelines that run tests but shouldn't modify configuration |
| **Read Only** | Stakeholders who need visibility into monitoring status |

### Adding Team Members
### Adding team members

Learn how to invite new users to your account.

[Learn more about adding team members](/admin/team-management/adding-team-members)

### Managing Team Members
### Managing team members

Change members' roles, remove members and invitations, change your own role, or leave an account.

[Learn more about managing team members](/admin/team-management/managing-team-members)

### Transferring Ownership
### Transferring ownership

**Owners** can transfer ownership to another team member from the [General](https://app.checklyhq.com/settings/account/general) section in account settings:

Expand All @@ -79,37 +79,37 @@ To move ownership to another email address, for example a shared team mailbox, i

If the current Owner is no longer at your company or can no longer access Checkly, reach out to [support@checklyhq.com](mailto:support@checklyhq.com) and we can transfer ownership for you. To verify that you're authorized to request the change, we'll ask you to provide a previous Checkly receipt or invoice.

## Account Management
## Account management

### Account name

The account Owner can change the account name from the [General](https://app.checklyhq.com/settings/account/general) section in account settings. By default the account name is the Owner's email address, but you can change it to reflect a department, product team, etc.

![set account name](/images/docs/images/teams/account_name.png)

### Email and Password Changes
### Email and password changes

Manage your login credentials and account information securely.

[Learn about changing your email or password](/admin/changing-your-email-password)

## Security

### Multi-Factor Authentication
### Multi-factor authentication

Add an extra layer of security to your account with MFA using authenticator apps.

[Set up multi-factor authentication](/admin/team-management/multi-factor-authentication)

### Single Sign-On (SSO)
### Single sign-on (SSO)

For enterprise customers, Checkly supports SSO integration with your existing identity provider.

[Learn about SSO options](/admin/team-management/single-sign-on)

## API Access
## API access

### Creating API Keys
### Creating API keys

Generate API keys for programmatic access to your Checkly account through the REST API and CLI.

Expand All @@ -119,6 +119,6 @@ Generate API keys for programmatic access to your Checkly account through the RE
- **User API Keys** - Tied to individual users with inherited permissions
- **Service API Keys** - Account-level keys for CI/CD and automation (Starter, Team, and Enterprise plans)

## Getting Help
## Getting help

If you need assistance with any administrative tasks or have questions about account management, please contact [Checkly Support](mailto:support@checklyhq.com).
4 changes: 2 additions & 2 deletions admin/team-management/single-sign-on.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: "Single Sign-on in Checkly"
title: "Single sign-on in Checkly"
description: "Overview of Single Sign-On (SSO) in Checkly for enterprise customers, including setting up the connection and other frequently asked questions"
sidebarTitle: "Single Sign-On"
sidebarTitle: "Single sign-on"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/single-sign-on/'
---

Expand Down
4 changes: 2 additions & 2 deletions ai/markdown-access.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Markdown Access'
title: 'Markdown access'
description: 'Access Checkly documentation as markdown to use with AI assistants and coding agents.'
sidebarTitle: 'Markdown Access'
sidebarTitle: 'Markdown access'
canonical: 'https://www.checklyhq.com/docs/ai/markdown-access/'
---

Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Checkly MCP Server'
title: 'Checkly MCP server'
description: 'Connect MCP clients to Checkly to inspect checks, test sessions, RCA, result assets, status pages, incidents, and account context.'
sidebarTitle: 'Overview'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/'
Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server/setup.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Set up the Checkly MCP Server'
title: 'Set up the Checkly MCP server'
description: 'Choose an authentication method, connect an MCP client, select an account, and verify the Checkly MCP Server connection.'
sidebarTitle: 'Setup'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/setup/'
Expand Down
2 changes: 1 addition & 1 deletion ai/mcp-server/troubleshooting.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Troubleshoot the Checkly MCP Server'
title: 'Troubleshoot the Checkly MCP server'
description: 'Resolve common Checkly MCP Server setup, authentication, account selection, and tool access issues.'
sidebarTitle: 'Troubleshooting'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/troubleshooting/'
Expand Down
6 changes: 3 additions & 3 deletions ai/overview.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'AI Agents & Coding Assistants'
title: 'AI agents & coding assistants'
description: 'Use AI agents and coding assistants with Checkly Skills and the Checkly MCP Server.'
sidebarTitle: 'Overview'
keywords: ['mcp', 'ai', 'generate checks', 'agents', 'context']
Expand Down Expand Up @@ -52,7 +52,7 @@ Install [Checkly Skills](/ai/skills) or connect the [Checkly MCP Server](/ai/mcp
For coding agents with repo and code access. Author Monitoring as Code with the Checkly CLI.
</Card>

<Card title="Checkly MCP Server" href="/ai/mcp-server" cta="Connect">
<Card title="Checkly MCP server" href="/ai/mcp-server" cta="Connect">
For desktop or sandboxed agents. Live access to Checkly account data and remote actions.
</Card>
</Columns>
Expand All @@ -77,7 +77,7 @@ For desktop or sandboxed agents. Live access to Checkly account data and remote
Every Checkly documentation page is available as markdown, and an `llms.txt` index lists them all. Both make it easy to pull the exact docs your agent needs into its context.

<Columns cols={2}>
<Card title="Markdown Access" href="/ai/markdown-access" cta="Learn more">
<Card title="Markdown access" href="/ai/markdown-access" cta="Learn more">
Append `.md` to any docs URL, request markdown with content negotiation, or copy a page as markdown.
</Card>

Expand Down
2 changes: 1 addition & 1 deletion ai/plugin.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
title: 'Checkly Plugin for AI Coding Agents'
title: 'Checkly plugin for AI coding agents'
description: 'Install the Checkly plugin to give your AI coding agent Checkly monitoring skills and Playwright best practices in a single package.'
sidebarTitle: 'Plugin'
canonical: 'https://www.checklyhq.com/docs/ai/plugin/'
Expand Down
12 changes: 6 additions & 6 deletions ai/rocky-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ canonical: 'https://www.checklyhq.com/docs/ai/rocky-ai/'

Rocky AI is Checkly's AI agent. Rocky AI can help you automatically determine user impact and root cause on any failing check using error messages, code, metrics, OTeL traces, trace routes, packet captures: essentially all artefact generated by a check or test.

## Rocky AI Capabilities
## Rocky AI capabilities

### AI Assistant

Use the [AI Assistant](./ai-assistant) to plan monitoring and create checks and monitors with a generated check intent.

### Automatic Check Repair
### Automatic check repair

Set an intent and enable [automatic repair](../resolve/automatic-check-repair) for a Browser or Multistep check.

### Root Cause and User Impact Analysis
### Root cause and user impact analysis

- **User Impact**: Rocky AI analyzes the failure and provides you with a list of impacted user groups and features.
- **Root Cause**: Rocky AI analyzes the failure and provides you with a root cause analysis.
- **Step Summary**: Rocky AI summarizes the steps in the check script, making it easier to understand what the check is doing and where it failed. This typically works for any Playwright based check.

[**Learn More**](/resolve/ai-root-cause-analysis/overview)

## Consumption and Invocations
## Consumption and invocations

By default, Rocky AI automatically analyzes every new *error group*. You can disable automatic analysis in the [AI settings](https://app.checklyhq.com/accounts/rocky-ai) to only spend invocations on manual analyses.

Expand All @@ -39,14 +39,14 @@ An **error group** is a deduplicated bucket of check failures that share the sam

A new group is created the first time a check fails with an error that doesn't match any existing group — and that's the event that triggers an automatic analysis. Because minor variations are normalized away, repeated failures of the same error reuse the existing group and don't consume additional invocations.

## Data Privacy and Security
## Data privacy and security

- All AI features are designed to operate on the data you provide or the data generated by your checks. This data is already stored in Checkly, and we do not send any additional data to third-party AI providers.
- Values of secret [environment variables](/platform/variables) are scrubbed from check results when the check runs, before the results are stored and before Rocky AI reads them.
- We do not train any custom models on your data.
- Any data used by the AI features is processed in real-time and not stored for future training.

## Built-in and Custom Models
## Built-in and custom models

By default, Checkly uses OpenAI's GPT-6.1 Sol model for AI features. You can also bring your own model (BYOM) by selecting a custom model in the [AI settings](https://app.checklyhq.com/accounts/rocky-ai).

Expand Down
2 changes: 1 addition & 1 deletion ai/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Provide the necessary Checkly context and let your AI agent of choice do the res

Using Checkly, you can now control your monitoring setup with AI agents without needing a specific MCP server or API for your monitoring. Tell your agent what you want to do and it will access the necessary context and use the CLI to manage your monitoring setup effectively.

## Skill Details
## Skill details

<Accordion title="Configure">
Create and manage monitoring checks, alert channels, dashboards, status pages, and other Checkly constructs using the CLI.
Expand Down
2 changes: 1 addition & 1 deletion api-reference/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ curl -H "Authorization: Bearer [apiKey]" -H "X-Checkly-Account: [accountId]"

[More information about managing API keys](/admin/creating-api-key), including service API keys.

## Rate Limits
## Rate limits

The Checkly Public API uses rate limits to help manage the sheer volume of requests we receive. The rate limit is characterized by allowing a maximum number of requests within a time interval.

Expand Down
8 changes: 4 additions & 4 deletions changelog/changelog.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,18 @@ description: Stay up to date with product updates and release notes across Check
canonical: 'https://www.checklyhq.com/docs/changelog/changelog/'
---

## Available Changelogs
## Available changelogs

<Card
title="Product Changelog"
title="Product changelog"
href="https://www.checklyhq.com/changelog/"
icon="rocket"
horizontal
>
Platform feature releases and changelog digests
</Card>

### Private Locations
### Private locations

<Card
title="Checkly Agent"
Expand All @@ -30,7 +30,7 @@ Release notes for the Checkly Agent
### Testing

<Card
title="Playwright Reporter"
title="Playwright reporter"
href="/detect/testing/playwright-reporter-changelog"
icon="test-pipe-2"
horizontal
Expand Down
2 changes: 1 addition & 1 deletion cli/attaching-git-metadata.mdx
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
title: 'Attaching Git metadata'
description: "Attach git metadata like branch, commit SHA, and owner to your Checkly test sessions and deployments so you can cross-reference monitoring with code changes."
sidebarTitle: 'Attaching Git Metadata'
sidebarTitle: 'Attaching Git metadata'
canonical: 'https://www.checklyhq.com/docs/cli/attaching-git-metadata/'
---

Expand Down
8 changes: 4 additions & 4 deletions cli/checkly-account.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ npx checkly account plan [key] [options]
| `--disabled` | - | Show only entitlements not included in your plan. |
| `--output, -o` | - | Output format: `table`, `json`, or `md`. Default: `table`. |

### Plan Options
### Plan options

<ResponseField name="key" type="string">

Expand Down Expand Up @@ -129,7 +129,7 @@ npx checkly account plan -o md

</ResponseField>

### Plan Examples
### Plan examples

```bash Terminal
# Show account plan summary (metered limits + flag count)
Expand All @@ -154,7 +154,7 @@ npx checkly account plan --disabled
npx checkly account plan BROWSER_CHECKS
```

### JSON Response
### JSON response

The `--output=json` format returns a structured response useful for programmatic access and AI agents.

Expand Down Expand Up @@ -195,7 +195,7 @@ Key fields:
- **`locations.all`** — filter to entries where `available` is `true` to get valid locations for your checks. Respect `maxPerCheck` as the upper bound per check.
- **`entitlements`** — metered entitlements include a `quantity` limit. Disabled entitlements include `requiredPlan` and `upgradeUrl`.

## Related Commands
## Related commands

- [`checkly members`](/cli/checkly-members) - List and manage account members
- [`checkly skills manage`](/cli/checkly-skills#checkly-skills-manage-resource) - Account management context for AI agents
Expand Down
Loading
Loading