CockroachDB website screenshot

CockroachDB

CockroachDB is a distributed SQL database with strong consistency, PostgreSQL compatibility, and a managed cloud offering. The Cloud API manages cluster lifecycle; the Cluster API exposes per-node operational state for monitoring and troubleshooting.

CockroachDB publishes 26 APIs on the APIs.io network, including APIKeys API, AuditLogs API, Auth API, and 23 more. Tagged areas include Cluster Management, Cloud, Database, Distributed SQL, and Infrastructure.

The CockroachDB catalog on APIs.io includes 1 event-driven AsyncAPI specification, 1 JSON-LD context, and 3 Spectral governance rulesets.

CockroachDB’s developer surface includes authentication, documentation, pricing, developer console, GitHub presence, engineering blog, and 11 more developer resources.

58.3/100 strong ▬ flat Agent 36/100 agent ready Full breakdown ↓
scored 2026-07-28 · rubric v0.6
AccessPaidSelf serve
26 APIs 16 Features
Cluster ManagementCloudDatabaseDistributed SQLInfrastructurePostgreSQL CompatibleSQL

Kin Score

Kin Score Kin Score How this is scored →
scored 2026-07-28 · rubric v0.6
Composite quality — 58.3/100 · strong
Contract Quality 19.7 / 25
Developer Ergonomics 6.5 / 20
Commercial Clarity 11.6 / 20
Operational Transparency 6.8 / 13
Governance 6.3 / 12
Discoverability 7.4 / 10
Agent readiness — 36/100 · agent ready
Machine-Readable Contract 18 / 18
Agentic Access Contract 10 / 10
MCP Server 0 / 12
Machine-Readable Auth 10 / 10
Idempotency 0 / 9
Stable Error Semantics 0 / 8
Request/Response Examples 0 / 7
Rate-Limit Signaling 7 / 7
Typed Event Surface 6 / 6
Agent Skills 0 / 5
Well-Known Catalog 0 / 4
Consent & Bot Identity 0 / 3
A2A Agent Card 0 / 8
Dry-Run / Simulate Mode 0 / 4
Improve this rating by publishing the missing artifacts — every area above can be raised, and the full rubric is at apis.io/rating/. This rating is computed from github.com/api-evangelist/cockroachdb: open an issue to ask a question, or submit a pull request to add artifacts. Want it done for you? Prioritized profiling — $2,500 →

APIs 26

Individual APIs this provider publishes, each with its own machine-readable definition.

CockroachDB APIKeys API

Manage API keys for programmatic access, including creation, retrieval, listing, updating, and deletion.

CockroachDB AuditLogs API

Retrieve audit log events for the organization to support compliance and security investigations.

CockroachDB Auth API

Authenticate to the Cluster API by creating and terminating API sessions. Session tokens are passed via the X-Cockroach-API-Session header on subsequent requests.

CockroachDB BackupRestore API

Manage cluster backups, backup configurations, and restore operations for CockroachDB clusters.

CockroachDB Billing API

Retrieve invoices and billing information for the CockroachDB Cloud organization.

CockroachDB Clusters API

Create, list, retrieve, update, and delete CockroachDB Serverless and Dedicated clusters within an organization.

CockroachDB CMEK API

Manage customer-managed encryption keys (CMEK) for encrypting cluster data at rest using customer-controlled keys.

CockroachDB Databases API

Manage databases within a CockroachDB cluster, including creation, listing, updating, and deletion.

CockroachDB EgressRules API

Configure egress traffic rules and egress private endpoints for outbound cluster network traffic.

CockroachDB Folders API

Organize clusters and other resources into hierarchical folder structures within the organization.

CockroachDB Health API

Check the health and readiness of individual CockroachDB nodes. The health endpoint can report whether the node is live and fully operational for accepting SQL connections.

CockroachDB IPAllowlists API

Configure IP allowlist entries to control network access to a cluster.

CockroachDB JWTIssuers API

Manage JWT issuer configurations for external identity provider integrations.

CockroachDB LogExport API

Configure log export to external destinations such as AWS CloudWatch or GCP Cloud Logging.

CockroachDB MaintenanceWindows API

Configure maintenance windows and blackout periods for cluster upgrade scheduling.

CockroachDB MetricExport API

Configure metric export integrations including AWS CloudWatch, Datadog, and Prometheus.

CockroachDB Nodes API

Retrieve information about all nodes in the cluster, including their status, address, locality, and operational metrics.

CockroachDB Organizations API

Retrieve information about the caller's CockroachDB Cloud organization.

CockroachDB PrivateEndpoints API

Manage private endpoint services and connections for secure VPC-level access to clusters.

CockroachDB Ranges API

List and inspect range information for the cluster, including hot ranges by node and detailed information for specific range IDs.

CockroachDB RoleManagement API

Manage role-based access control, including assigning and removing roles for users across organization, folder, and cluster scopes.

CockroachDB Rules API

Retrieve alerting rules templates for use with Prometheus-compatible alerting systems.

CockroachDB ServiceAccounts API

Manage service accounts used for machine-to-machine authentication within the organization.

CockroachDB Sessions API

List active SQL sessions across all nodes of the cluster, with optional filtering by username.

CockroachDB SQLUsers API

Manage SQL users for a cluster, including creating users, listing users, and updating SQL user passwords.

CockroachDB VersionDeferral API

Manage cluster version deferral policies to delay automatic CockroachDB version upgrades.

Scroll for all 26

Postman Collections 26

Ready-to-run Postman collections for exercising this provider's APIs.

Scroll for all 26

Open Collections 2

Open, tool-agnostic API collections (OpenAPI-derived and Bruno).

CockroachDB Cloud API

OPEN COLLECTION

CockroachDB Cluster API

OPEN COLLECTION

Pricing Plans 1

Published pricing tiers and plan structures.

Rate Limits 1

Documented rate limits and quota policies.

Cockroachdb Rate Limits

3 limits

RATE LIMITS

FinOps 1

Cost, billing, and metering signals for API financial operations.

Features 16

Notable capabilities this provider offers.

Basic free: 50M RUs + 10 GiB storage/mo, scales to zero
Standard from $0.18/hr (2 vCPUs): provisioned compute up to 200 vCPUs
Advanced from $0.60/hr (4 vCPUs): unlimited scale, CMEK, PCI/HIPAA
Multi-region across AWS/GCP/Azure
Postgres wire-compatible SQL
Strongly consistent multi-region writes
Cloud API at 60 req/min/user
Datadog metrics export (Standard+)
Private connectivity (Standard+)
Up to 99.999% availability (Advanced)
Customer-managed encryption keys (CMEK) on Advanced
Backup and PITR included
Distributed SQL with horizontal scale
JSONB and full-text search
Geo-partitioned tables
ACID transactions across regions

Scroll for all 16

Event Specifications 1

AsyncAPI definitions for this provider's event-driven and streaming APIs.

CockroachDB CHANGEFEED Sinks

AsyncAPI description of CockroachDB CHANGEFEED INTO sinks. CockroachDB Enterprise CHANGEFEEDs stream row-level change data to external systems. This document models the publicly...

ASYNCAPI

Semantic Vocabularies 1

JSON-LD contexts and semantic vocabularies used across these APIs.

Cockroachdb Context

0 classes · 14 properties

JSON-LD

Spectral Rules 3

Spectral governance rulesets for linting and validating these APIs.

CockroachDB API Rules

6 rules · 6 warnings

SPECTRAL

CockroachDB API Rules

6 rules · 5 warnings 1 info

SPECTRAL

CockroachDB API Rules

10 rules · 3 errors 4 warnings 3 info

SPECTRAL

JSON Schema 96

Standalone JSON Schema definitions for this provider's data models.

AddEgressRuleRequest

4 properties

JSON SCHEMA

AddJWTIssuerRequest

2 properties

JSON SCHEMA

AddPrivateEndpointConnectionRequest

1 properties

JSON SCHEMA

Address

2 properties

JSON SCHEMA

AllowlistEntry

5 properties

JSON SCHEMA

ApiKey

4 properties

JSON SCHEMA

AvailableRegion

3 properties

JSON SCHEMA

BackupConfiguration

3 properties

JSON SCHEMA

BuildInfo

9 properties

JSON SCHEMA

CloudWatchMetricExportInfo

3 properties

JSON SCHEMA

CockroachDB Cluster

24 properties

JSON SCHEMA

ClusterConfig

2 properties

JSON SCHEMA

ClusterNode

3 properties

JSON SCHEMA

ClusterVersionDeferral

1 properties

JSON SCHEMA

CMEKClusterInfo

3 properties

JSON SCHEMA

CMEKClusterSpecification

1 properties

JSON SCHEMA

CreateApiKeyRequest

2 properties

JSON SCHEMA

CreateApiKeyResponse

2 properties

JSON SCHEMA

CreateClusterRequest

5 properties

JSON SCHEMA

CreateDatabaseRequest

1 properties

JSON SCHEMA

CreateFolderRequest

2 properties

JSON SCHEMA

CreateRestoreRequest

2 properties

JSON SCHEMA

CreateServiceAccountRequest

2 properties

JSON SCHEMA

CreateSQLUserRequest

2 properties

JSON SCHEMA

Database

2 properties

JSON SCHEMA

DatadogMetricExportInfo

3 properties

JSON SCHEMA

DedicatedClusterConfig

5 properties

JSON SCHEMA

EditEgressRuleRequest

3 properties

JSON SCHEMA

EgressRule

5 properties

JSON SCHEMA

EnableCloudWatchMetricExportRequest

2 properties

JSON SCHEMA

EnableDatadogMetricExportRequest

2 properties

JSON SCHEMA

EnableLogExportRequest

3 properties

JSON SCHEMA

Error

3 properties

JSON SCHEMA

Folder

4 properties

JSON SCHEMA

GetAllRolesForUserResponse

1 properties

JSON SCHEMA

GetConnectionStringResponse

1 properties

JSON SCHEMA

GetPersonUsersByEmailResponse

1 properties

JSON SCHEMA

HealthResponse

2 properties

JSON SCHEMA

HotRange

7 properties

JSON SCHEMA

Invoice

5 properties

JSON SCHEMA

JWTIssuer

3 properties

JSON SCHEMA

ListAllowlistEntriesResponse

2 properties

JSON SCHEMA

ListApiKeysResponse

2 properties

JSON SCHEMA

ListAuditLogsResponse

1 properties

JSON SCHEMA

ListAvailableRegionsResponse

2 properties

JSON SCHEMA

ListBackupsResponse

2 properties

JSON SCHEMA

ListClusterNodesResponse

2 properties

JSON SCHEMA

ListClustersResponse

2 properties

JSON SCHEMA

ListDatabasesResponse

2 properties

JSON SCHEMA

ListEgressRulesResponse

2 properties

JSON SCHEMA

ListFolderContentsResponse

1 properties

JSON SCHEMA

ListFoldersResponse

2 properties

JSON SCHEMA

ListHotRangesResponse

2 properties

JSON SCHEMA

ListInvoicesResponse

1 properties

JSON SCHEMA

ListJWTIssuersResponse

2 properties

JSON SCHEMA

ListMajorClusterVersionsResponse

1 properties

JSON SCHEMA

ListNodeRangesResponse

2 properties

JSON SCHEMA

ListNodesResponse

2 properties

JSON SCHEMA

ListPrivateEndpointServicesResponse

1 properties

JSON SCHEMA

ListRestoresResponse

2 properties

JSON SCHEMA

ListRoleGrantsResponse

2 properties

JSON SCHEMA

ListServiceAccountsResponse

2 properties

JSON SCHEMA

ListSessionsResponse

3 properties

JSON SCHEMA

ListSQLUsersResponse

2 properties

JSON SCHEMA

Locality

1 properties

JSON SCHEMA

LogExportClusterInfo

3 properties

JSON SCHEMA

LoginRequest

2 properties

JSON SCHEMA

LoginResponse

1 properties

JSON SCHEMA

LogoutResponse

1 properties

JSON SCHEMA

MaintenanceWindow

2 properties

JSON SCHEMA

NodeDescriptor

9 properties

JSON SCHEMA

NodeStatus

9 properties

JSON SCHEMA

Organization

4 properties

JSON SCHEMA

PaginationResponse

3 properties

JSON SCHEMA

PrivateEndpointConnection

5 properties

JSON SCHEMA

PrometheusMetricExportInfo

2 properties

JSON SCHEMA

RangeDescriptor

4 properties

JSON SCHEMA

RangeInfo

8 properties

JSON SCHEMA

RangeResponse

2 properties

JSON SCHEMA

Region

3 properties

JSON SCHEMA

Restore

4 properties

JSON SCHEMA

ServerlessClusterConfig

3 properties

JSON SCHEMA

ServiceAccount

5 properties

JSON SCHEMA

Session

11 properties

JSON SCHEMA

SetRolesForUserRequest

1 properties

JSON SCHEMA

SQLUser

1 properties

JSON SCHEMA

UpdateApiKeySpecification

1 properties

JSON SCHEMA

UpdateBackupConfigurationSpec

2 properties

JSON SCHEMA

UpdateClusterSpecification

3 properties

JSON SCHEMA

UpdateCMEKStatusRequest

1 properties

JSON SCHEMA

UpdateDatabaseRequest

1 properties

JSON SCHEMA

UpdateFolderSpecification

2 properties

JSON SCHEMA

UpdateJWTIssuerRequest

2 properties

JSON SCHEMA

UpdateServiceAccountSpecification

2 properties

JSON SCHEMA

UpdateSQLUserPasswordRequest

1 properties

JSON SCHEMA

Scroll for all 96

JSON Structure 1

JSON Structure definitions describing this provider's data shapes.

Cockroachdb Structure

0 properties

JSON STRUCTURE

Security Posture 4

Authentication, domain security, vulnerability disclosure, and trust-center signals.

Cockroachdb Authentication

apiKey/http · 2 schemes

SECURITY

Cockroachdb Domain Security

TLSv1.3 · HSTS · DNSSEC · DMARC

SECURITY

Cockroachdb Vulnerability Disclosure

disclosure policy published

SECURITY

Cockroachdb Trust Center

SOC 2, ISO 27001, PCI DSS, HIPAA, FIPS 140

SECURITY

Agentic Access 1

Recommended x-agentic-access execution contracts for AI agents.

Cockroachdb Agentic Access

98 operations · 51 acting · 5 human-in-the-loop

98 operations · 51 acting

AGENTIC

Resources

Get Started 1

Portal, sign-up, and the first successful call

Documentation 2

Reference material describing how the API behaves

Agent Surfaces 1

MCP servers, agent skills, and machine-readable catalogs

Design & Contract 2

Pagination, idempotency, versioning, errors, and events

Build 2

SDKs, sample code, and the tooling you integrate with

Access & Security 4

Authentication, authorization, and security posture

Operate 1

Status, limits, changes, and where to get help

Commercial 1

Pricing, plans, and the legal terms of use

Company 3

The organization behind the API

Source (apis.yml)

apis.yml Raw ↑
aid: cockroachdb
url: https://raw.githubusercontent.com/api-evangelist/cockroachdb/refs/heads/main/apis.yml
name: CockroachDB
description: CockroachDB is a distributed SQL database with strong consistency, PostgreSQL compatibility, and a managed cloud
  offering. The Cloud API manages cluster lifecycle; the Cluster API exposes per-node operational state for monitoring and
  troubleshooting.
tags:
- Cluster Management
- Cloud
- Database
- Distributed SQL
- Infrastructure
- PostgreSQL Compatible
- SQL
type: Index
accessModel:
  pricing: paid
  onboarding: self-serve
  trial: false
  try_now: false
  public: false
  label: Paid · Self-serve signup
  confidence: high
  source:
  - plans
  - authentication
  generated: '2026-07-22'
  method: derived
image: https://kinlane-images.s3.amazonaws.com/shared/apis-json/icons/cockroachdb.png
access: 3rd-Party
kind: company
created: '2024-11-24'
modified: '2026-05-19'
position: Consumer
x-overview: 'CockroachDB is a distributed, PostgreSQL-compatible SQL database built by Cockroach Labs. It scales horizontally,
  survives disk, machine, rack, and data-center failures with localized fallout, and provides ACID transactions across geographies.
  CockroachDB is offered as a fully managed service on cockroachlabs.cloud (Basic, Standard, Advanced plans) and as self-hosted
  software. Two REST APIs are available: the CockroachDB Cloud API for managing the lifecycle of cloud-hosted clusters, and
  the per-node CockroachDB Cluster API for cluster health, monitoring, and operational status.'
apis:
- aid: cockroachdb:cockroachdb-apikeys-api
  name: CockroachDB APIKeys API
  description: Manage API keys for programmatic access, including creation, retrieval, listing, updating, and deletion.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - APIKeys
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-apikeys-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-auditlogs-api
  name: CockroachDB AuditLogs API
  description: Retrieve audit log events for the organization to support compliance and security investigations.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - AuditLogs
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-auditlogs-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-auth-api
  name: CockroachDB Auth API
  description: Authenticate to the Cluster API by creating and terminating API sessions. Session tokens are passed via the
    X-Cockroach-API-Session header on subsequent requests.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Auth
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-auth-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-backuprestore-api
  name: CockroachDB BackupRestore API
  description: Manage cluster backups, backup configurations, and restore operations for CockroachDB clusters.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - BackupRestore
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-backuprestore-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-billing-api
  name: CockroachDB Billing API
  description: Retrieve invoices and billing information for the CockroachDB Cloud organization.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Billing
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-billing-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-clusters-api
  name: CockroachDB Clusters API
  description: Create, list, retrieve, update, and delete CockroachDB Serverless and Dedicated clusters within an organization.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Clusters
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-clusters-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-cmek-api
  name: CockroachDB CMEK API
  description: Manage customer-managed encryption keys (CMEK) for encrypting cluster data at rest using customer-controlled
    keys.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - CMEK
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-cmek-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-databases-api
  name: CockroachDB Databases API
  description: Manage databases within a CockroachDB cluster, including creation, listing, updating, and deletion.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Databases
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-databases-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-egressrules-api
  name: CockroachDB EgressRules API
  description: Configure egress traffic rules and egress private endpoints for outbound cluster network traffic.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - EgressRules
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-egressrules-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-folders-api
  name: CockroachDB Folders API
  description: Organize clusters and other resources into hierarchical folder structures within the organization.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Folders
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-folders-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-health-api
  name: CockroachDB Health API
  description: Check the health and readiness of individual CockroachDB nodes. The health endpoint can report whether the
    node is live and fully operational for accepting SQL connections.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Health
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-health-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-ipallowlists-api
  name: CockroachDB IPAllowlists API
  description: Configure IP allowlist entries to control network access to a cluster.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - IPAllowlists
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-ipallowlists-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-jwtissuers-api
  name: CockroachDB JWTIssuers API
  description: Manage JWT issuer configurations for external identity provider integrations.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - JWTIssuers
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-jwtissuers-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-logexport-api
  name: CockroachDB LogExport API
  description: Configure log export to external destinations such as AWS CloudWatch or GCP Cloud Logging.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - LogExport
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-logexport-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-maintenancewindows-api
  name: CockroachDB MaintenanceWindows API
  description: Configure maintenance windows and blackout periods for cluster upgrade scheduling.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - MaintenanceWindows
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-maintenancewindows-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-metricexport-api
  name: CockroachDB MetricExport API
  description: Configure metric export integrations including AWS CloudWatch, Datadog, and Prometheus.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - MetricExport
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-metricexport-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-nodes-api
  name: CockroachDB Nodes API
  description: Retrieve information about all nodes in the cluster, including their status, address, locality, and operational
    metrics.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Nodes
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-nodes-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-organizations-api
  name: CockroachDB Organizations API
  description: Retrieve information about the caller's CockroachDB Cloud organization.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Organizations
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-organizations-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-privateendpoints-api
  name: CockroachDB PrivateEndpoints API
  description: Manage private endpoint services and connections for secure VPC-level access to clusters.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - PrivateEndpoints
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-privateendpoints-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-ranges-api
  name: CockroachDB Ranges API
  description: List and inspect range information for the cluster, including hot ranges by node and detailed information for
    specific range IDs.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Ranges
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-ranges-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-rolemanagement-api
  name: CockroachDB RoleManagement API
  description: Manage role-based access control, including assigning and removing roles for users across organization, folder,
    and cluster scopes.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - RoleManagement
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-rolemanagement-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-rules-api
  name: CockroachDB Rules API
  description: Retrieve alerting rules templates for use with Prometheus-compatible alerting systems.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Rules
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-rules-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-serviceaccounts-api
  name: CockroachDB ServiceAccounts API
  description: Manage service accounts used for machine-to-machine authentication within the organization.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - ServiceAccounts
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-serviceaccounts-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-sessions-api
  name: CockroachDB Sessions API
  description: List active SQL sessions across all nodes of the cluster, with optional filtering by username.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - Sessions
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-sessions-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-sqlusers-api
  name: CockroachDB SQLUsers API
  description: Manage SQL users for a cluster, including creating users, listing users, and updating SQL user passwords.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - SQLUsers
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-sqlusers-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
- aid: cockroachdb:cockroachdb-versiondeferral-api
  name: CockroachDB VersionDeferral API
  description: Manage cluster version deferral policies to delay automatic CockroachDB version upgrades.
  humanURL: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  baseURL: https://cockroachlabs.cloud
  tags:
  - VersionDeferral
  properties:
  - type: OpenAPI
    url: openapi/cockroachdb-versiondeferral-api-openapi.yml
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cloud/v1
  - type: Documentation
    url: https://www.cockroachlabs.com/docs/stable/cluster-api
  - type: APIReference
    url: https://www.cockroachlabs.com/docs/api/cluster/v2
common:
- type: PostmanWorkspace
  url: https://www.postman.com/kinlaneapi/cockroachdb/overview
- type: AgenticAccess
  url: agentic-access/cockroachdb-agentic-access.yml
- type: TrustCenter
  url: security/cockroachdb-trust-center.yml
- type: VulnerabilityDisclosure
  url: security/cockroachdb-vulnerability-disclosure.yml
- type: DomainSecurity
  url: security/cockroachdb-domain-security.yml
- type: Authentication
  url: authentication/cockroachdb-authentication.yml
- type: LinkedIn
  url: https://www.linkedin.com/company/cockroach-labs
- url: json-schema/cockroachdb-cluster-schema.json
  type: JSONSchema
- url: json-ld/cockroachdb-context.jsonld
  type: JSONLD
- url: rules/cockroachdb-rules.yml
  type: Spectral
- type: Website
  url: https://www.cockroachlabs.com/product/
- type: Documentation
  url: https://www.cockroachlabs.com/docs/
- type: Pricing
  url: https://www.cockroachlabs.com/pricing/
- type: Console
  url: https://cockroachlabs.cloud/
- type: GitHub
  url: https://github.com/cockroachdb/cockroach
- type: StatusPage
  url: https://status.cockroachlabs.cloud/
- type: Features
  data:
  - 'Basic free: 50M RUs + 10 GiB storage/mo, scales to zero'
  - 'Standard from $0.18/hr (2 vCPUs): provisioned compute up to 200 vCPUs'
  - 'Advanced from $0.60/hr (4 vCPUs): unlimited scale, CMEK, PCI/HIPAA'
  - Multi-region across AWS/GCP/Azure
  - Postgres wire-compatible SQL
  - Strongly consistent multi-region writes
  - Cloud API at 60 req/min/user
  - Datadog metrics export (Standard+)
  - Private connectivity (Standard+)
  - Up to 99.999% availability (Advanced)
  - Customer-managed encryption keys (CMEK) on Advanced
  - Backup and PITR included
  - Distributed SQL with horizontal scale
  - JSONB and full-text search
  - Geo-partitioned tables
  - ACID transactions across regions
  sources:
  - https://www.cockroachlabs.com/pricing/
  updated: '2026-05-04'
- type: Integrations
  url: https://www.cockroachlabs.com/partners/
- type: Blog
  url: https://cockroachlabs.com/rss.xml
integrations:
- name: partner-icon
- name: Become a partner
maintainers:
- FN: Kin Lane
  email: kin@apievangelist.com
specificationVersion: '0.19'