{
  "opencollection": "1.0.0",
  "info": {
    "name": "CockroachDB Cloud APIKeys Ranges API",
    "version": "2024-09-16"
  },
  "request": {
    "auth": {
      "type": "bearer",
      "token": "{{bearerToken}}"
    }
  },
  "items": [
    {
      "info": {
        "name": "Ranges",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List ranges for a node",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cockroachlabs.cloud/api/v2/nodes/:node_id/ranges/",
            "params": [
              {
                "name": "node_id",
                "value": "",
                "type": "path",
                "description": "Numeric identifier of the CockroachDB node."
              },
              {
                "name": "ranges",
                "value": "",
                "type": "query",
                "description": "Comma-separated list of range IDs to filter results. If omitted, all ranges on the node are returned."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return in a single response."
              },
              {
                "name": "offset",
                "value": "",
                "type": "query",
                "description": "Number of results to skip before returning data. Used for offset-based pagination."
              }
            ]
          },
          "docs": "Returns information about ranges stored on the specified node. If a list of range IDs is provided via the ranges query parameter, only information about those specific ranges is returned. Requires admin authentication."
        },
        {
          "info": {
            "name": "List hot ranges",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cockroachlabs.cloud/api/v2/ranges/hot/",
            "params": [
              {
                "name": "node_id",
                "value": "",
                "type": "query",
                "description": "Filter hot ranges by the ID of the node to query. If omitted, hot ranges across all nodes are returned."
              },
              {
                "name": "limit",
                "value": "",
                "type": "query",
                "description": "Maximum number of results to return in a single response."
              },
              {
                "name": "start",
                "value": "",
                "type": "query",
                "description": "Pagination cursor for the starting position in the result set."
              }
            ]
          },
          "docs": "Returns information about hot ranges across the cluster, ranked by query activity. Optionally filter by node ID to return only hot ranges on a specific node. Requires admin authentication."
        },
        {
          "info": {
            "name": "Get a range",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://cockroachlabs.cloud/api/v2/ranges/:range_id/",
            "params": [
              {
                "name": "range_id",
                "value": "",
                "type": "path",
                "description": "Numeric identifier of the range."
              }
            ]
          },
          "docs": "Retrieves detailed information about a specific range identified by range_id, including replica placement, lease holder, and statistics. Requires admin authentication."
        }
      ]
    }
  ],
  "bundled": true
}