Skip to content
Merged
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
  •  
  •  
  •  
1 change: 1 addition & 0 deletions admin/changing-your-email-password.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,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"
canonical: 'https://www.checklyhq.com/docs/admin/changing-your-email-password/'
---

Changing your email and / or password is handled differently depending on how you signed up for Checkly. Please check below for the scenario that applies to you:
Expand Down
1 change: 1 addition & 0 deletions admin/creating-api-key.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,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"
canonical: 'https://www.checklyhq.com/docs/admin/creating-api-key/'
---

The Checkly public API and CLI use API keys to authenticate requests. API keys come in two flavors: **user API keys** and **service API keys**.
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/adding-team-members.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,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"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/adding-team-members/'
---

You can invite team members to join your Checkly account to view and manage all checks and related settings; team members can have different [roles](/admin/team-management/overview).
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/microsoft-azure-ad.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Using Microsoft Entra ID for Single Sign-on in Checkly"
description: "This page illustrates the standard procedure to follow in order to get started with Microsoft Entra ID SSO (formerly Azure AD) on Checkly. "
sidebarTitle: "Microsoft Entra ID"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/microsoft-azure-ad/'
---

## Initial SSO configuration
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/multi-factor-authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
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"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/multi-factor-authentication/'
---

You can add an extra layer of security to your account with an additional verification method, also known as multi-factor authentication, or MFA.
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
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.
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/saml.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "SAML for Single Sign-on in Checkly"
description: "Learn how to configure SAML SSO integration with Checkly for your organization"
sidebarTitle: "SAML"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/saml/'
---

## Initial SSO setup
Expand Down
1 change: 1 addition & 0 deletions admin/team-management/single-sign-on.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Single Sign-on in Checkly"
description: "Overview of Single Sign-On (SSO) options available in Checkly for enterprise security"
sidebarTitle: "Overview"
canonical: 'https://www.checklyhq.com/docs/admin/team-management/single-sign-on/'
---

Single Sign-On (SSO) enables businesses to secure employee access across a variety of third-party services. Currently, Checkly supports the following SSO protocols:
Expand Down
1 change: 1 addition & 0 deletions ai/llms-txt.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'llms.txt'
description: 'Use the Checkly llms.txt file to discover and crawl all available documentation pages as markdown.'
sidebarTitle: 'llms.txt'
canonical: 'https://www.checklyhq.com/docs/ai/llms-txt/'
---

The [llms.txt standard](https://llmstxt.org/) provides a machine-readable index of all available documentation pages. Checkly publishes an `llms.txt` file at [`checklyhq.com/llms.txt`](https://www.checklyhq.com/llms.txt) that lists every documentation page with its markdown URL and a short description.
Expand Down
1 change: 1 addition & 0 deletions ai/markdown-access.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Markdown Access'
description: 'Access Checkly documentation as markdown to use with AI assistants and coding agents.'
sidebarTitle: 'Markdown Access'
canonical: 'https://www.checklyhq.com/docs/ai/markdown-access/'
---

Every page in the Checkly documentation is available as markdown. This makes it easy to feed specific documentation pages into AI assistants like Claude, ChatGPT, Cursor, or any other AI tool.
Expand Down
1 change: 1 addition & 0 deletions ai/mcp-server.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
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/'
---

The Checkly MCP Server lets MCP clients connect to Checkly over Streamable HTTP and use Checkly tools from your conversation.
Expand Down
1 change: 1 addition & 0 deletions ai/mcp-server/security-and-permissions.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'MCP security and permissions'
description: 'Understand how the Checkly MCP Server authenticates users, filters tools by permission, handles account context, and protects write actions.'
sidebarTitle: 'Security & permissions'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/security-and-permissions/'
---

The Checkly MCP Server uses bearer-token authentication and Checkly account authorization together. Session permissions decide which tools are visible to your MCP client. Checkly account membership, role, and feature entitlements decide whether a specific tool call can operate on an account.
Expand Down
1 change: 1 addition & 0 deletions ai/mcp-server/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Set up the Checkly MCP Server'
description: 'Configure OAuth or API-key authentication for the Checkly MCP Server over Streamable HTTP.'
sidebarTitle: 'Setup'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/setup/'
---

Use the production MCP endpoint in your client:
Expand Down
1 change: 1 addition & 0 deletions ai/mcp-server/tools.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Checkly MCP tools'
description: 'Reference for the tools exposed by the Checkly MCP Server, grouped by workflow.'
sidebarTitle: 'Tools'
canonical: 'https://www.checklyhq.com/docs/ai/mcp-server/tools/'
---

This reference reflects the current MCP Server v1 tool surface. It is not a roadmap or a commitment to future tools.
Expand Down
1 change: 1 addition & 0 deletions ai/mcp-server/troubleshooting.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
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/'
---

<Accordion title="Before you begin">
Expand Down
1 change: 1 addition & 0 deletions ai/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ 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']
canonical: 'https://www.checklyhq.com/docs/ai/overview/'
---

import AgentExamples from "/snippets/agent-example.mdx"
Expand Down
1 change: 1 addition & 0 deletions ai/rocky-ai.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: "Rocky AI"
description: "Learn about Rocky AI — Checkly's AI agent — and configuring and using AI features"
sidebarTitle: "Rocky AI"
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.
Expand Down
1 change: 1 addition & 0 deletions ai/skills.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@
title: 'Checkly Skills'
description: 'Official Checkly skills to give any AI agent on-demand best practices, context, and product capabilities.'
sidebarTitle: 'Skills'
canonical: 'https://www.checklyhq.com/docs/ai/skills/'
---

import AgentExamples from "/snippets/agent-example.mdx"
Expand Down
1 change: 1 addition & 0 deletions api-reference/accounts/fetch-a-given-account-details.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/{accountId}
title: Get details for a specific account
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/fetch-a-given-account-details/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/fetch-account-entitlements.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/{accountId}/entitlements
title: Fetch account entitlements
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/fetch-account-entitlements/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/fetch-current-account-details.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/me
title: Get details for the current account
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/fetch-current-account-details/'
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/me/entitlements
title: Fetch current account entitlements
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/fetch-current-account-entitlements/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/fetch-user-accounts.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts
title: Get details for all accounts
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/fetch-user-accounts/'
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/{accountId}/members
title: List account members and pending invites
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/list-account-members-and-pending-invites/'
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/accounts/me/members
title: List current account members and pending invites
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/list-current-account-members-and-pending-invites/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/remove-a-current-account-member.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: delete /v1/accounts/me/members/{userId}
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/remove-a-current-account-member/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/remove-an-account-member.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: delete /v1/accounts/{accountId}/members/{userId}
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/remove-an-account-member/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: patch /v1/accounts/me/members/{userId}
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/update-a-current-account-member-role/'
---
1 change: 1 addition & 0 deletions api-reference/accounts/update-an-account-member-role.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: patch /v1/accounts/{accountId}/members/{userId}
canonical: 'https://www.checklyhq.com/docs/api-reference/accounts/update-an-account-member-role/'
---
1 change: 1 addition & 0 deletions api-reference/alert-channels/create-an-alert-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: post /v1/alert-channels
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/create-an-alert-channel/'
---
1 change: 1 addition & 0 deletions api-reference/alert-channels/delete-an-alert-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: delete /v1/alert-channels/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/delete-an-alert-channel/'
---
1 change: 1 addition & 0 deletions api-reference/alert-channels/list-all-alert-channels.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/alert-channels
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/list-all-alert-channels/'
---
1 change: 1 addition & 0 deletions api-reference/alert-channels/retrieve-an-alert-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/alert-channels/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/retrieve-an-alert-channel/'
---
1 change: 1 addition & 0 deletions api-reference/alert-channels/update-an-alert-channel.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: put /v1/alert-channels/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/update-an-alert-channel/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: put /v1/alert-channels/{id}/subscriptions
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-channels/update-the-subscriptions-of-an-alert-channel/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/alert-notifications
canonical: 'https://www.checklyhq.com/docs/api-reference/alert-notifications/lists-all-alert-notifications/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/api-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/api-checks/{id}
title: API checks
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/api-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/browser-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/browser-checks/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/browser-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/dns-monitors.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/dns/{id}
title: DNS monitors
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/dns-monitors/'
---
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: post /v1/analytics/checks
title: Get analytics summary for multiple checks
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/get-analytics-summary-for-multiple-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/heartbeat-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/heartbeat-checks/{id}
title: Heartbeat monitors
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/heartbeat-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/icmp-monitors.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/icmp/{id}
title: ICMP monitors
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/icmp-monitors/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/metrics
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/list-all-available-reporting-metrics/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/multistep-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/multistep-checks/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/multistep-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/playwright-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/playwright-checks/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/playwright-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/ssl-monitors.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/analytics/ssl/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/ssl-monitors/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/tcp-checks.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/tcp-checks/{id}
title: TCP monitors
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/tcp-checks/'
---
1 change: 1 addition & 0 deletions api-reference/analytics/url-monitors.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/analytics/url-monitors/{id}
title: URL monitors
canonical: 'https://www.checklyhq.com/docs/api-reference/analytics/url-monitors/'
---
1 change: 1 addition & 0 deletions api-reference/badges/get-v1badgeschecks.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/badges/checks/{checkId}
title: Get badge for a check
canonical: 'https://www.checklyhq.com/docs/api-reference/badges/get-v1badgeschecks/'
---
1 change: 1 addition & 0 deletions api-reference/badges/get-v1badgesgroups.mdx
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
---
openapi: get /v1/badges/groups/{groupId}
title: Get badge for a group
canonical: 'https://www.checklyhq.com/docs/api-reference/badges/get-v1badgesgroups/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-alerts/{checkId}
canonical: 'https://www.checklyhq.com/docs/api-reference/check-alerts/list-alerts-for-a-specific-check/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-alerts
canonical: 'https://www.checklyhq.com/docs/api-reference/check-alerts/list-all-alerts-for-your-account/'
---
1 change: 1 addition & 0 deletions api-reference/check-groups/create-a-check-group-v2.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: post /v2/check-groups
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/create-a-check-group-v2/'
---
1 change: 1 addition & 0 deletions api-reference/check-groups/create-a-check-group.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
---
openapi: post /v1/check-groups
deprecated: true
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/create-a-check-group/'
---

<Warning>
Expand Down
1 change: 1 addition & 0 deletions api-reference/check-groups/delete-a-check-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: delete /v1/check-groups/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/delete-a-check-group/'
---
1 change: 1 addition & 0 deletions api-reference/check-groups/list-all-check-groups.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-groups
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/list-all-check-groups/'
---
1 change: 1 addition & 0 deletions api-reference/check-groups/retrieve-a-check-group.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-groups/{id}
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-a-check-group/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-groups/{id}/checks
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-all-checks-in-a-specific-group-with-group-settings-applied/'
---
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
---
openapi: get /v1/check-groups/{groupId}/checks/{checkId}
canonical: 'https://www.checklyhq.com/docs/api-reference/check-groups/retrieve-one-check-in-a-specific-group-with-group-settings-applied/'
---
Loading
Loading