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

Cockroach Cluster Ops (BYOK) — connector documentation

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

What Cockroach Cluster Ops (BYOK) is for

Cockroach Cluster Ops (BYOK) lets an AI assistant read your own Cockroach Cluster Ops data through the Cockroach Cluster Ops API with a key you supply (service account API key secret). Read-only: 9 tools (get_backup_configuration, list_restores, get_restore, get_maintenance_window, list_blackout_windows, get_version_deferral, list_egress_rules, list_private_endpoint_services, list_major_versions). 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 cockroachlabs.cloud. Unofficial connector by Unify Dynamics LLC: not affiliated with, endorsed by or sponsored by Cockroach Cluster Ops. Cockroach Cluster Ops 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:

  • "How often is my CockroachDB cluster backed up and for how long are backups kept?"
  • "Did the last CockroachDB restore finish?"
  • "What is the status of CockroachDB restore r1?"
  • "When is the CockroachDB maintenance window for my cluster?"
  • "Are there blackout windows scheduled for my CockroachDB cluster?"
  • "Is my CockroachDB cluster deferring major version upgrades?"

What it does

  • get_backup_configuration: Get a cluster's managed backup settings: whether backups are on, how often they run in minutes and how many days they are kept.
  • list_restores: List restore jobs of a cluster with status, type, source and destination cluster, backup used, progress and any error message. Can filter by time range.
  • get_restore: Get one restore job: status, type, clusters involved, backup used, progress and error message.
  • get_maintenance_window: Get a cluster's maintenance window: when it starts (offset from Monday 00:00 UTC) and how long it lasts.
  • list_blackout_windows: List a cluster's blackout windows, during which maintenance is not applied, with start and end time.
  • get_version_deferral: Get a cluster's version upgrade deferral policy (not deferred, 30, 60 or 90 days, or fixed) and the date until which upgrades are deferred.
  • list_egress_rules: List a cluster's outbound traffic (egress) rules with name, destination, type (FQDN or CIDR), allowed ports and state.
  • list_private_endpoint_services: List the private endpoint services of a cluster (for example AWS PrivateLink) with cloud provider, region, status and service name.
  • list_major_versions: List the CockroachDB major versions available on CockroachDB Cloud with release type, support status, support end date and allowed upgrade targets.

BYOK key

You bring your own Cockroach Cluster Ops service account API key secret (https://www.cockroachlabs.com/docs/cockroachcloud/managing-access). 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 cockroachlabs.cloud 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 Cockroach Cluster Ops API (cockroachlabs.cloud) with a BYOK key; documentation: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api. 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 Cockroach Cluster Ops. Cockroach Cluster Ops 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 Cockroach Cluster Ops account.

Built for: Worldwide. Languages: English.