How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Need help?

Contact us
CockroachDB

CockroachDB Ranges API

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

Documentation Provider Profile APIs.io OpenAPI GitHub

CockroachDB Ranges API is one of 26 APIs that CockroachDB publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Ranges. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.

This API exposes 3 operations across 3 paths, and defines 7 schemas. It is described by OpenAPI 3.2.0, at version 2.0.0.

Requests are made against a single base URL, https://localhost:8080.

3 operations 3 paths 7 schemas 3 GET

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
2.0.0
Base URL
https://cockroachlabs.cloud
Authentication
API Key
Contact
Cockroach Labs Support
Terms of Service
View terms
Resource Areas
1

Authentication & Security 1

CockroachDB Ranges API declares 1 security scheme for authenticating requests. An API key is passed in the header as X-Cockroach-API-Session (sessionAuth). By default, every request must be authenticated.

  • sessionAuth — Session token obtained from the /api/v2/login/ endpoint. Include this header with all authenticated requests.

Paths & Operations 3

Across 3 paths, the API surfaces 3 operations — 3 GET. Each is listed below with its method, path, parameters, and response codes.

Ranges 3

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

GET
/api/v2/nodes/{node_id}/ranges/
List ranges for a node
ListNodeRanges 4 params → 200401403404
GET
/api/v2/ranges/hot/
List hot ranges
ListHotRanges 3 params → 200401403
GET
/api/v2/ranges/{range_id}/
Get a range
GetRange 1 param → 200401403404

Schemas 7

The contract defines 7 schemas that model the data the API accepts and returns. The most detailed are RangeInfo (8 properties), HotRange (7 properties), RangeDescriptor (4 properties), ListNodeRangesResponse (2 properties). Each schema is shown below with its type and property counts.

Error
object
Standard error response returned by the Cluster API.
1 property
ListHotRangesResponse
object
Hot ranges across the cluster or filtered to a specific node.
2 properties
RangeResponse
object
Detailed information about a specific range from all replicas.
2 properties
RangeInfo
object
Information about a single range, including span, replica placement, lease holder, and per-replica statistics.
8 properties
RangeDescriptor
object
Describes a range's identity, key bounds, and replica set.
4 properties
ListNodeRangesResponse
object
Range information for a specific node with pagination metadata.
2 properties
HotRange
object
A range identified as hot due to elevated query activity, including the range descriptor and per-second query throughput.
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

cockroachdb-ranges-api-openapi.yml Raw ↑

Other APIs CockroachDB publishes across the network.

CockroachDB APIKeys API
AE Profile APIs.io
CockroachDB AuditLogs API
AE Profile APIs.io
CockroachDB Auth API
AE Profile APIs.io
CockroachDB BackupRestore API
AE Profile APIs.io
CockroachDB Billing API
AE Profile APIs.io
CockroachDB Clusters API
AE Profile APIs.io
CockroachDB CMEK API
AE Profile APIs.io
CockroachDB Databases API
AE Profile APIs.io
CockroachDB EgressRules API
AE Profile APIs.io
CockroachDB Folders API
AE Profile APIs.io
CockroachDB Health API
AE Profile APIs.io
CockroachDB IPAllowlists API
AE Profile APIs.io
#Ranges
← Back to C APIs
API Details
ID
cockroachdb:cockroachdb-ranges-api
Base URL
https://cockroachlabs.cloud
Docs
https://www.cockroachlabs.com/docs/cockroachcloud/cloud-api
Provider
CockroachDB
APIs.io →  GitHub →
Explore more
All APIs Providers APIs.io Network
Work with this as data

Every API here is available over the API and to AI agents over MCP. APIs is not yet its own endpoint on the v1 API. Reach this content through network search and the tag graph, or the MCP server below.

Installs https://mcp.apievangelist.com/mcp in Claude, Cursor, VS Code and the rest — one button, every client.

MCP tools for apis
4 tools reach this content
  • search_api_evangelistSearch every content type across the network at once.
  • find_relatedThe shared-tag relevance graph — what else covers this.
  • get_tagEverything one tag labels, across all content types.
  • guide_topicPRO — a curated bundle for a topic: area, guidance, rules, papers, stories, services.
All tools & prompts
Call it yourself
curl for this page
Search the network for this 
curl "https://api.apievangelist.com/v1/search?q=cockroachdb-ranges-api&limit=10"
Everything under a tag 
curl "https://api.apievangelist.com/v1/tags/cockroachdb-ranges-api"

Discovery needs no key. Full bodies and the synthesis endpoints are Pro.

Get an API key

Free tier, no email required. Sign in with whichever identity you already have.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have. Your account

Where this information came from

This is an independent, third-party profile of CockroachDB Ranges API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.