License: Business Source LicenseREST API for querying information about CockroachDB cluster health, nodes, ranges, sessions, and other meta information. For more information on how to use this API, see the .
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CockroachDB","colors":{"primary":"#9059FF","light":"#9059FF","dark":"#9059FF"},"logo":{"light":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_Black.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=54ccae625c9986bf1df8ddc7b2c571f0","dark":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_White.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=0dd9b66973a1c7d3dd72aa67b6094efe","href":"https://www.cockroachlabs.com/"},"favicon":{"light":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551","dark":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551"},"api":{"examples":{"defaults":"required","languages":["curl"]}},"appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Get started free","href":"https://cockroachlabs.cloud/signup?referralId=cc_nav_global\u0026_ga=2.242886210.1147139380.1759903632-41552699.1759903632"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@cockroachdb","x":"https://x.com/CockroachDB","linkedin":"https://www.linkedin.com/company/cockroach-labs/mycompany/verification","instagram":"https://www.instagram.com/cockroachdb"},"links":[{"header":"Product","items":[{"label":"CockroachDB","href":"https://www.cockroachlabs.com/product"},{"label":"CockroachDB Cloud","href":"https://www.cockroachlabs.com/product/cockroachcloud"},{"label":"Compare","href":"https://www.cockroachlabs.com/compare"},{"label":"Pricing","href":"https://www.cockroachlabs.com/pricing"},{"label":"Get CockroachDB","href":"https://www.cockroachlabs.com/get-started-cockroachdb"},{"label":"Sign In","href":"https://cockroachlabs.cloud/"}]},{"header":"Resources","items":[{"label":"Guides","href":"https://resources.cockroachlabs.com/guides"},{"label":"Webinars","href":"https://www.cockroachlabs.com/community/webinars"},{"label":"Videos","href":"https://www.cockroachlabs.com/resources/video"},{"label":"Architecture Overview","href":"https://www.cockroachlabs.com/docs/stable/architecture/overview"},{"label":"FAQ","href":"https://www.cockroachlabs.com/docs/stable/frequently-asked-questions"},{"label":"Security","href":"https://www.cockroachlabs.com/security"}]},{"header":"Learn \u0026 Support","items":[{"label":"Docs","href":"https://www.cockroachlabs.com/docs"},{"label":"University","href":"https://learn.cockroachlabs.com/"},{"label":"Developers","href":"https://www.cockroachlabs.com/developers"},{"label":"Forum","href":"https://forum.cockroachlabs.com/"},{"label":"Slack","href":"https://cockroa.ch/slack"},{"label":"Support Portal","href":"https://support.cockroachlabs.com/hc/en-us"},{"label":"Contact Us","href":"https://www.cockroachlabs.com/contact"}]},{"header":"Company","items":[{"label":"About","href":"https://www.cockroachlabs.com/about"},{"label":"Blog","href":"https://www.cockroachlabs.com/blog"},{"label":"Careers","href":"https://www.cockroachlabs.com/careers"},{"label":"Customers","href":"https://www.cockroachlabs.com/customers"},{"label":"News","href":"https://www.cockroachlabs.com/press"},{"label":"Privacy","href":"https://www.cockroachlabs.com/privacy"},{"label":"Terms of Use","href":"https://www.cockroachlabs.com/website-terms-of-use"}]}]},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Open Sans"}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"latex":true},"integrations":{"gtm":{"tagId":"GTM-NR8LC4"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. [Return to docs home](/index.html)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cockroachlabs","hasAudioNarration":false,"actualSubdomain":"cockroachlabs","customDomains":["docs.cockroachlabs.com"],"gitSource":{"type":"github","owner":"cockroachlabs","repo":"docs","deployBranch":"main","contentDirectory":"cockroachlabs-preview-main","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc24f9d1a26b8362e3268c","collectionId":"7d02ecdd-010f-452c-a839-1542479b4ee8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc24f9d1a26b8362e3268c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adc24f9d1a26b8362e3268c","clientVersion":"0.0.3965","searchFilterCounts":[{"language":"default","tag":"CockroachDB","count":6968},{"language":"default","tag":"Docs","count":3238},{"language":"default","tag":"SQL","count":2562},{"language":"default","tag":"Statements","count":1710},{"language":"default","tag":"Self-Hosted Deployments","count":1479},{"language":"default","tag":"Reference","count":774},{"language":"default","tag":"Cloud Deployments","count":616},{"language":"default","tag":"Endpoints","count":528},{"language":"default","tag":"Cloud API Reference","count":518},{"language":"default","tag":"Get Started","count":441}],"searchSettings":{"isFiltersEnabled":false}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--inline-code-bg-light:rgb(var(--gray-200) / 0.92);--inline-code-bg-dark:rgb(255 255 255 / 0.08)}.prose :not(pre)>code{background-color:var(--inline-code-bg-light)!important}.dark .prose :not(pre)>code{background-color:var(--inline-code-bg-dark)!important}@media (min-width:1536px){#navbar>.max-w-8xl,[class*=\"peer-[.is-not-custom]:peer-[.is-not-center]:max-w-8xl\"]{width:100%!important;max-width:none!important}}#navigation-items{display:flex;flex-direction:column}#navigation-items>ul:not(.sidebar-group){order:1;margin-top:1.5rem}.crdb-fixed-table table,.crdb-metrics-table table{table-layout:fixed!important;width:100%!important;min-width:0!important;max-width:100%!important;border-collapse:collapse}.crdb-fixed-table table td,.crdb-fixed-table table th,.crdb-metrics-table table td,.crdb-metrics-table table th{min-width:0!important;overflow-wrap:anywhere;word-break:break-word}.bg-cover{background-size:cover;background-repeat:no-repeat;background-position:center center}.bg-cover__bg-3-1{background-image:url(https://cockroach-labs-docs.imgix.net/bg-3-1.png?auto=format,compress\u0026w=1200\u0026q=40)}.home-header{border-radius:.5rem;margin-bottom:2rem!important;padding:2rem}.card{border:1px solid #e5e7eb;border-radius:.75rem;background-color:#fff}.dark .card{background-color:#0d1117;border-color:rgba(255,255,255,.1)}.card-link,.card-link:hover{transform:none!important;box-shadow:none!important}.card-link{text-decoration:none!important;overflow:hidden}.card-link:hover{outline:1px solid rgba(105,51,255,.55);outline-offset:-1px}.card-link a,.card-link a:hover,.card-link h3,.card-link h3:hover,.card-link p,.card-link p:hover{border:0!important;text-decoration:none!important;transform:none!important}.card-link a{display:block;width:100%}.card-link h3{font-size:1rem!important;font-weight:600!important}.card-body{padding:1.5rem}.landing-column-title{margin-bottom:1rem}.article-lists h3,.overline{text-transform:uppercase;letter-spacing:.05em}.btn-redirect{display:inline-flex;align-items:center;gap:.5rem;padding:.75rem 1.5rem;border:2px solid #e5e7eb;border-radius:.5rem;text-decoration:none;transition:border-color .2s}.btn-redirect:hover{border-color:#6933ff}.btn-block{display:flex;width:100%;justify-content:center}.dark .btn-redirect{border-color:rgba(255,255,255,.1)}.article-section-title{font-size:1.25rem!important}.article-lists h3{font-size:.875rem!important;font-weight:600!important;color:#6b7280!important}.dark .article-lists h3,.dark .card-link .card-desc{color:#9ca3af!important}.article-lists ul{font-size:.875rem}.shadow{box-shadow:0 .5rem 1rem rgba(0,0,0,.15)}.bg-dark-wing{background-color:#152849;border-radius:.5rem}.text-ice-temple{color:#1bf8ec!important;display:inline-flex;align-items:center;gap:.375rem}.text-ice-temple img{display:inline-block;margin:0}.bg-dark-wing h2{font-size:clamp(1.25rem,1rem + 1.5vw,1.75rem)!important}@media (max-width:576px){.card-body.bg-dark-wing{padding:1.25rem!important}}.text-decoration-none{text-decoration:none!important}.text-muted{color:#6b7280!important}.card-link .card-desc{font-size:.9375rem!important;font-weight:400!important;line-height:1.5!important;text-align:left!important;color:#4b5563!important;width:100%;margin-top:.5rem}.report-tag{display:inline-block;padding:.25rem .75rem;border-radius:.25rem;background-color:rgba(84,42,189,.08);color:#542abd}.dark .report-tag{background-color:rgba(84,42,189,.3);color:#b39dff}.resilience-report-img{background-image:url(/images/state-resilience.png);background-size:cover;background-position:center;min-height:150px;border-radius:.5rem}.row{flex-wrap:wrap;margin-left:-.75rem;margin-right:-.75rem}.display-flex,.row{display:flex!important}.col-lg-4{flex:0 0 auto;width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-4{width:33.333333%!important}}.col-lg-3,.col-sm-6,.col-xs-12{flex:0 0 auto;width:100%!important;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-3{width:25%!important}}@media (min-width:576px){.col-sm-6{width:50%!important}}.col-12{width:100%!important}.col-lg-12{width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-12{width:100%!important}}.col-md-4,.col-md-8{flex:0 0 auto;width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:768px){.col-md-4{width:33.333333%!important}.col-md-8{width:66.666667%!important}}.h-100{height:100%}.d-flex{display:flex}.flex-column{flex-direction:column}.mb-3{margin-bottom:1rem!important}.mb-5{margin-bottom:3rem!important}.pb-5{padding-bottom:3rem!important}.mb-xl-5{margin-bottom:3rem!important}.mt-auto{margin-top:auto!important}.mt-0{margin-top:0!important}.mt-2{margin-top:.5rem!important}.mt-3{margin-top:1rem!important}.mt-5:not(.code-block){margin-top:3rem!important}.code-block.mb-8{margin-bottom:calc(var(--spacing)*5)}.pt-5{padding-top:3rem!important}.m-0{margin:0!important}.ml-2{margin-left:.5rem!important}.mb-0{margin-bottom:0!important}.mb-2{margin-bottom:.5rem!important}.mb-4{margin-bottom:1.5rem!important}.p-2{padding:.5rem!important}.p-3{padding:1rem!important}.p-4{padding:1.5rem!important}.pb-3{padding-bottom:1rem!important}.pb-4{padding-bottom:1.5rem!important}.ml-1{margin-left:.25rem!important}.mr-auto{margin-right:auto!important}.justify-content-center{justify-content:center!important}.align-items-center{align-items:center!important}@media (min-width:1200px){.p-xl-5{padding:3rem!important}}.mx-0{margin-left:0!important;margin-right:0!important}.text-center{text-align:center}.dark .text-black,.text-white{color:#fff!important}.text-black{color:#000!important}.container{width:100%;max-width:1200px;margin-left:auto;margin-right:auto;padding-left:1rem;padding-right:1rem}.card-header-overlap-text{position:relative}@media (min-width:768px){.p-md-5{padding:3rem!important}}@media (min-width:992px){.d-lg-flex{display:flex!important}.mb-lg-0{margin-bottom:0!important}}.prose table{border-collapse:collapse!important}.prose table td,.prose table th{border:1px solid rgb(var(--gray-200))!important}.dark .prose table td,.dark .prose table th{border-color:rgb(var(--gray-700)/.5)!important}.prose table th{padding:.571429em;font-weight:600;vertical-align:bottom;color:var(--tw-prose-headings);text-align:left}.prose table th.center-align{text-align:center}.prose table td{padding:.571429em;vertical-align:baseline}[data-component-part=accordion-description]{font-size:.875rem!important}.accordion.mb-3{margin-bottom:.25rem!important}@media (max-width:991.98px){[id^=kapa-widget-container] button{width:36px!important;height:36px!important;min-width:36px!important;padding:0!important;font-size:0!important}[id^=kapa-widget-container] button svg{width:18px!important;height:18px!important}[id^=kapa-widget-container] button span{display:none!important}}table.crdb-fixed-table{table-layout:fixed!important;min-width:0!important;width:100%}table.crdb-fixed-table td,table.crdb-fixed-table th{min-width:0!important;overflow-wrap:break-word;word-break:normal}.sql-grammar svg .line{fill:none;stroke:#262626}.sql-grammar svg .bold-line{stroke:#0a0a0a;shape-rendering:crispEdges;stroke-width:2}.sql-grammar svg .thin-line{stroke:#0f0f0f;shape-rendering:crispEdges}.sql-grammar svg .filled{fill:#262626;stroke:none}.sql-grammar svg text.terminal{font-family:Verdana,Sans-serif;font-size:12px;fill:#0a0a0a;font-weight:700}.sql-grammar svg text.nonterminal,.sql-grammar svg text.regexp{font-family:Verdana,Sans-serif;font-size:12px;fill:#05f}.sql-grammar svg text.regexp{fill:#0f0f0f}.sql-grammar svg circle,.sql-grammar svg polygon,.sql-grammar svg rect{fill:#262626;stroke:#262626}.sql-grammar svg polygon.regexp,.sql-grammar svg rect.nonterminal,.sql-grammar svg rect.terminal{fill:#fff;stroke:#262626}.sql-grammar svg rect.text{fill:none;stroke:none}.sql-grammar svg{background-color:#fff}.sql-grammar a[name]::before{content:'';display:block;height:80px;margin:-80px 0 0}.sql-grammar a[name]:focus{outline:0}pre[language=sql][data-crdb-prompt-stripped] code::before{content:\"> \";color:#94e2d5;user-select:none}.mark-yes{color:#008a5e;font-weight:600}.dark .mark-yes{color:#3ddc97}"}],"page":{"pagePath":"docs/api/cluster/index","slug":"/docs/api/cluster/index","pageMetadata":{"title":"CockroachDB Cluster API (2.0)","hideFooterPagination":true,"description":null,"href":"/docs/api/cluster/index"},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];const InternalLink=({version,path=``,children,...props})=>{const _components={a:`a`,..._provideComponents()};let detectedVersion=version||`stable`;if(typeof window!==`undefined`\u0026\u0026!version){const match=window.location.pathname.match(/\\/docs\\/([^/]+)/);if(match){detectedVersion=match[1]}}const normalizedPath=path.startsWith(`/`)?path.slice(1):path;return _jsx(_components.a,{href:`/docs/${detectedVersion}/${normalizedPath}`,...props,children})};function _createMdxContent(props){const _components={p:`p`,..._provideComponents(),...props.components},{_MdxComponentBoundary}=_components;if(!_MdxComponentBoundary)_missingMdxReference(`_MdxComponentBoundary`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:`License: Business Source License`}),`\n`,_jsxs(_components.p,{children:[`REST API for querying information about CockroachDB cluster health, nodes, ranges, sessions, and other meta information. For more information on how to use this API, see the `,_jsx(_MdxComponentBoundary,{name:`InternalLink`,children:_jsx(InternalLink,{version:`stable`,path:`cluster-api`,children:`Cluster API documentation`})}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{InternalLink,default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"config":{},"pageMetadata":{"title":"CockroachDB Cluster API (2.0)","hideFooterPagination":true,"description":null,"href":"/docs/api/cluster/index"}}},"mdxSourceWithNoJs":null,"noJsSplices":[[148,586,")=>null;function _cr"]]},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cockroachlabs/4695317e415d4eba/kapa.js","/_mintlify/custom/cockroachlabs/40fb45a3cfe42c92/copy-code-prompt.js"],"subdomain":"cockroachlabs","siteName":"CockroachDB","title":"CockroachDB Cluster API (2.0) - CockroachDB","navMaps":{"firstHrefInVersion":{"v26.4":{"href":"/docs/api/cluster","matchLevel":2},"v26.3":{"href":"/docs/api/cluster","matchLevel":2},"v26.2":{"href":"/docs/api/cluster/index","matchLevel":0},"v26.1":{"href":"/docs/api/cluster/index","matchLevel":0},"v25.4":{"href":"/docs/api/cluster/index","matchLevel":0},"v25.3":{"href":"/docs/api/cluster/index","matchLevel":0},"v25.2":{"href":"/docs/api/cluster/index","matchLevel":0},"v25.1":{"href":"/docs/api/cluster/index","matchLevel":0},"v24.3":{"href":"/docs/api/cluster/index","matchLevel":0},"v24.1":{"href":"/docs/api/cluster/index","matchLevel":0},"v23.2":{"href":"/docs/api/cluster/index","matchLevel":0},"v23.1":{"href":"/docs/api/cluster/index","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-24T02:20:11.671Z","originalFileLocation":"docs/api/cluster/index.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"application-name\" content=\"CockroachDB\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"CockroachDB Cluster API (2.0) - CockroachDB\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CockroachDB\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cockroachlabs.com/docs/api/cluster\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cockroachlabs.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=CockroachDB+Cluster+API+%282.0%29\u0026amp;theme=7628870a42004e67b5b3df3d\u0026amp;signature=1937e7eb2c0cdb0fe992608ef87a81a343acce473c0622620e75494e3b3ee895\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"CockroachDB Cluster API (2.0) - CockroachDB\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cockroachlabs.mintlify.app/_mintlify/api/og/v2?division=Overview\u0026amp;title=CockroachDB+Cluster+API+%282.0%29\u0026amp;theme=7628870a42004e67b5b3df3d\u0026amp;signature=1937e7eb2c0cdb0fe992608ef87a81a343acce473c0622620e75494e3b3ee895\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/cockroachlabs/c9BlkJ0WBi2Ma7w-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"CockroachDB\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#9059FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.cockroachlabs.com/docs/api/cluster\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/cluster/index.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.cockroachlabs.com/#organization\",\"name\":\"CockroachDB\",\"url\":\"https://docs.cockroachlabs.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_Black.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=54ccae625c9986bf1df8ddc7b2c571f0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.cockroachlabs.com#website\",\"name\":\"CockroachDB\",\"url\":\"https://docs.cockroachlabs.com\",\"publisher\":{\"@id\":\"https://docs.cockroachlabs.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster#webpage\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cluster\",\"name\":\"CockroachDB Cluster API (2.0)\",\"dateModified\":\"2026-10-24T02:20:11.671Z\",\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Overview\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cluster/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"CockroachDB Cluster API (2.0)\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cluster\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster#article\",\"headline\":\"CockroachDB Cluster API (2.0)\",\"name\":\"CockroachDB Cluster API (2.0)\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cluster\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster#webpage\"},\"dateModified\":\"2026-10-24T02:20:11.671Z\",\"publisher\":{\"@id\":\"https://docs.cockroachlabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"}}]}\u003c/script>","siteName":"CockroachDB","nav":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"products":[{"product":"Cockroach Continuum Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cockroachlabs/images/continuum/cockroachlabs-symbol.svg","description":"The agentic database cloud","pages":[{"title":"Cockroach Continuum Cloud","href":"/docs/continuum"}]},{"product":"CockroachDB","icon":"database","description":"Distributed SQL database","versions":[{"version":"v26.4","tag":"Development","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v26.4"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v26.4/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v26.4/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v26.4/troubleshooting-overview"}]}]},{"version":"v26.3","default":true,"tag":"Stable","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/stable"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/stable/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/stable/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/stable/troubleshooting-overview"}]}]},{"version":"v26.2","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v26.2"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v26.2/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v26.2/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v26.2/troubleshooting-overview"}]}]},{"version":"v26.1","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v26.1"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v26.1/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v26.1/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v26.1/troubleshooting-overview"}]}]},{"version":"v25.4","tag":"LTS","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v25.4"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v25.4/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v25.4/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v25.4/troubleshooting-overview"}]}]},{"version":"v25.3","tag":"Unsupported","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v25.3"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v25.3/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v25.3/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v25.3/troubleshooting-overview"}]}]},{"version":"v25.2","tag":"LTS","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v25.2"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v25.2/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v25.2/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v25.2/troubleshooting-overview"}]}]},{"version":"v25.1","tag":"Unsupported","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v25.1"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v25.1/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v25.1/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v25.1/troubleshooting-overview"}]}]},{"version":"v24.3","tag":"LTS","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v24.3"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v24.3/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v24.3/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v24.3/troubleshooting-overview"}]}]},{"version":"v24.1","tag":"LTS","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v24.1"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v24.1/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v24.1/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v24.1/troubleshooting-overview"}]}]},{"version":"v23.2","tag":"LTS","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v23.2"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v23.2/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v23.2/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v23.2/troubleshooting-overview"}]}]},{"version":"v23.1","tag":"Unsupported","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v23.1"}]},{"tab":"Migrate","icon":"arrow-right-arrow-left","pages":[{"title":"Migrate","href":"/docs/molt/migration-overview"}]},{"tab":"SQL","icon":"code","pages":[{"title":"SQL","href":"/docs/v23.1/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v23.1/architecture/glossary"}]},{"tab":"Cluster API","icon":"rocket","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cluster API (2.0)","href":"/docs/api/cluster"}]},{"group":"Endpoints","expanded":true,"pages":[{"group":"API Reference","pages":[{"title":"List databases","description":"List all databases on this cluster.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/","href":"/docs/api/cluster/v2/list-databases"},{"title":"Get database descriptor ID","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/","href":"/docs/api/cluster/v2/get-database-descriptor-id"},{"title":"List grants on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/grants/","href":"/docs/api/cluster/v2/list-grants-on-a-database"},{"title":"List tables on a database","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/","href":"/docs/api/cluster/v2/list-tables-on-a-database"},{"title":"Get table details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /databases/{database}/tables/{table}/","href":"/docs/api/cluster/v2/get-table-details"},{"title":"List events","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /events/","href":"/docs/api/cluster/v2/list-events"},{"title":"Check node health","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /health/","href":"/docs/api/cluster/v2/check-node-health"},{"title":"Log in","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /login/","href":"/docs/api/cluster/v2/log-in"},{"title":"Log out","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json post /logout/","href":"/docs/api/cluster/v2/log-out"},{"title":"List nodes","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/","href":"/docs/api/cluster/v2/list-nodes"},{"title":"List node ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /nodes/{node_id}/ranges/","href":"/docs/api/cluster/v2/list-node-ranges"},{"title":"List hot ranges","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/hot/","href":"/docs/api/cluster/v2/list-hot-ranges"},{"title":"Get range details","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /ranges/{range_id}/","href":"/docs/api/cluster/v2/get-range-details"},{"title":"List sessions","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions"},{"title":"List users","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /users/","href":"/docs/api/cluster/v2/list-users"}]}]}]},{"tab":"Troubleshoot","icon":"bug","pages":[{"title":"Troubleshoot","href":"/docs/v23.1/troubleshooting-overview"}]}]}]},{"product":"Cloud Deployments","icon":"cloud","description":"Fully managed CockroachDB","pages":[{"title":"Cloud Deployments","href":"/docs/cockroachcloud"}]},{"product":"Releases","icon":"list","description":"Version history, support policy \u0026 advisories","pages":[{"title":"Releases","href":"/docs/releases"}]}]},"title":"CockroachDB Cluster API (2.0) - CockroachDB","buildId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","deploymentId":"dpl_849ArpqvBiCczQiT1Y1stNGpbqHT","dynamics":[],"chunks":[]}
