Skip to content

api-evangelist/cockroachdb

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

11 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

CockroachDB (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.

APIs.json: https://raw.githubusercontent.com/api-evangelist/cockroachdb/refs/heads/main/apis.yml

Scope

  • Type: Index
  • Position: Consumer
  • Access: 3rd-Party

Tags

  • Cluster Management
  • Cloud
  • Database
  • Distributed SQL
  • Infrastructure
  • PostgreSQL Compatible
  • SQL

Timestamps

  • Created: 2024-11-24
  • Modified: 2026-05-19

APIs

CockroachDB Cloud API

REST API for managing the lifecycle of CockroachDB Cloud clusters. Supports cluster provisioning, scaling, deletion, SQL user management, network authorization (IP allowlists, private endpoints), customer-managed encryption keys (CMEK), maintenance windows, version deferral, audit log export, metric and log export, SCIM v2 group/user provisioning, folder organization, service accounts, API keys, invoices, and backup configuration. Authenticated via bearer tokens and rate-limited to 10 requests per second per user.

Tags

  • Cloud
  • Cluster Management
  • Database
  • Infrastructure

Properties

CockroachDB Cluster API

REST API hosted by every CockroachDB node under the /api/v2 base path, exposed on the same HTTP port as the DB Console (default 8080). Provides health checks, node detail, hot range info, session and query introspection, database and table metadata, and event log retrieval. Authentication uses session tokens obtained via /api/v2/login/ and passed in the X-Cockroach-API-Session header.

Tags

  • Cluster
  • Database
  • Monitoring
  • Nodes
  • Observability

Properties

Common Properties

Maintainers

FN: Kin Lane Email: kin@apievangelist.com

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors