Be the first to get access to new connectors. Get early access →
ConnectorBay Early access

Checkly Platform (BYOK) — connector documentation

  • MCP endpoint: https://byok-checkly-platform.connectorbay.com/mcp
  • REST API: POST https://byok-checkly-platform.connectorbay.com/v1/tools/{tool_name}, described by the OpenAPI 3.1 spec at https://byok-checkly-platform.connectorbay.com/openapi.json
  • Transport: Streamable HTTP, stateless, MCP specification 2025-06-18 or later
  • Authentication: your own Checkly Platform Checkly user API key, sent in the X-Upstream-Key header and the Checkly account id in X-Upstream-Key-2 of every request (never stored, logged or cached)
  • Health: https://byok-checkly-platform.connectorbay.com/health · Tool schemas: https://byok-checkly-platform.connectorbay.com/tools.json
  • Publisher: Unify Dynamics LLC · connectorbay.com/byok-checkly-platform · agent@connectorbay.com

What Checkly Platform (BYOK) is for

Checkly Platform (BYOK) lets an AI assistant read your own Checkly Platform data through the Checkly Platform API with a key you supply (Checkly user API key). Read-only: 10 tools (get_entitlements, get_usage_summary, get_usage_terms, list_error_groups, get_error_group, list_test_sessions, list_private_locations, list_locations, list_runtimes, list_variable_names). The BYOK key travels with each request, is used for that one call only and is never stored, logged or cached; it is only ever sent to api.checklyhq.com. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Checkly Platform. Checkly Platform and its logos are trademarks of their owners and are used only to say which service the connector works with.

Ask your assistant things like:

  • "What does my Checkly plan include?"
  • "How many Checkly credits have I used this period?"
  • "What is my Checkly credit budget and contract period?"
  • "Which error groups are open in Checkly?"
  • "Show one Checkly error group"
  • "Did the latest Checkly test sessions pass?"

What it does

  • get_entitlements: Show the account plan and its entitlements: which features are enabled, metered quantities and the most locations one check may use.
  • get_usage_summary: Show credit usage totals and projections for the current usage period, optionally for a date range.
  • get_usage_terms: Show the current usage terms: contract dates, credit budget, credits per unit and package model.
  • list_error_groups: List error groups (similar check failures grouped together) with cleaned message, check id and first and last seen times.
  • get_error_group: Get one error group by id with its cleaned message, check id and first and last seen times.
  • list_test_sessions: List test sessions (runs of monitoring-as-code tests) with name, status, branch, environment and times; newest first. Page with nextId.
  • list_private_locations: List private locations with name, slug, agent count, last seen time and minimum agent version. Agent keys are not returned.
  • list_locations: List the public locations (regions) checks can run from.
  • list_runtimes: List the supported check runtimes with Node.js version, stage and end-of-life date.
  • list_variable_names: List the names of environment variables and whether each is locked or secret. Values are not returned.

BYOK key

You bring your own Checkly Platform Checkly user API key (https://app.checklyhq.com/settings/user/api-keys). Your assistant sends it in the X-Upstream-Key header with each request. ConnectorBay uses it for that one call only: it is never stored, logged or cached, never shown in an answer, and it is only sent to api.checklyhq.com over https, with no redirects followed. Create a key with the fewest permissions the tools need (read-only if the provider offers it), and revoke it at the provider whenever you like.

Data sources

Live from the Checkly Platform API (api.checklyhq.com) with a BYOK key; documentation: https://www.checklyhq.com/docs/api-reference/openapi.json. Endpoints checked against that documentation on 2026-10-16.

What it is not

Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Checkly Platform. Checkly Platform and its logos are trademarks of their owners and are used only to say which service the connector works with. It is read-only: it never creates, changes, sends or deletes anything in your Checkly Platform account.

Built for: Worldwide. Languages: English.