Token for logged-in REST session. Use /login/ to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.
{"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":""},"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":"6af4bb21d7a808c67a4ac795","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"CockroachDB","count":6951},{"language":"default","tag":"Docs","count":3217},{"language":"default","tag":"SQL","count":2566},{"language":"default","tag":"Statements","count":1714},{"language":"default","tag":"Self-Hosted Deployments","count":1457},{"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":true,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","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":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","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":"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":"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":"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":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","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":"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":"workos-sso-scim","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},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":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-metrics-table table{table-layout:fixed!important;width:100%!important;min-width:0!important;max-width:100%!important;border-collapse:collapse}.crdb-metrics-table table td,.crdb-metrics-table table th{min-width:0!important;overflow-wrap:anywhere;word-break:break-word}.crdb-fixed-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{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:0.5rem;margin-bottom:2rem!important;padding:2rem}.card{border:1px solid #e5e7eb;border-radius:0.75rem;background-color:white}.dark .card{background-color:#0d1117;border-color:rgba(255, 255, 255, 0.1)}.card-link{text-decoration:none!important;overflow:hidden}.card-link:hover{outline:1px solid rgba(105, 51, 255, 0.55);outline-offset:-1px}.card-link,.card-link:hover{transform:none!important;box-shadow:none!important}.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}.overline{text-transform:uppercase;letter-spacing:0.05em}.btn-redirect{display:inline-flex;align-items:center;gap:0.5rem;padding:0.75rem 1.5rem;border:2px solid #e5e7eb;border-radius:0.5rem;text-decoration:none;transition:border-color 0.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, 0.1)}.article-section-title{font-size:1.25rem!important}.article-lists h3{font-size:0.875rem!important;font-weight:600!important;text-transform:uppercase;letter-spacing:0.05em;color:#6b7280!important}.dark .article-lists h3{color:#9ca3af!important}.article-lists ul{font-size:0.875rem}.shadow{box-shadow:0 0.5rem 1rem rgba(0, 0, 0, 0.15)}.bg-dark-wing{background-color:#152849;border-radius:0.5rem}.text-ice-temple{color:#1bf8ec!important;display:inline-flex;align-items:center;gap:0.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:0.9375rem!important;font-weight:400!important;line-height:1.5!important;text-align:left!important;color:#4b5563!important;width:100%;margin-top:0.5rem}.dark .card-link .card-desc{color:#9ca3af!important}.report-tag{display:inline-block;padding:0.25rem 0.75rem;border-radius:0.25rem;background-color:rgba(84, 42, 189, 0.08);color:#542abd}.dark .report-tag{background-color:rgba(84, 42, 189, 0.3);color:#b39dff}.resilience-report-img{background-image:url(\"/images/state-resilience.png\");background-size:cover;background-position:center;min-height:150px;border-radius:0.5rem}.row{display:flex!important;flex-wrap:wrap;margin-left:-0.75rem;margin-right:-0.75rem}.display-flex{display:flex!important}.col-lg-4{flex:0 0 auto;width:100%;padding-left:0.75rem;padding-right:0.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:0.75rem;padding-right:0.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:0.75rem;padding-right:0.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:0.75rem;padding-right:0.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:0.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:0.5rem!important}.mb-0{margin-bottom:0!important}.mb-2{margin-bottom:0.5rem!important}.mb-4{margin-bottom:1.5rem!important}.p-2{padding:0.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:0.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}.text-white{color:white!important}.text-black{color:black!important}.dark .text-black{color:white!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 th,.prose table td{border:1px solid rgb(var(--gray-200))!important}.dark .prose table th,.dark .prose table td{border-color:rgb(var(--gray-700) / 0.5)!important}.prose table th{padding:0.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:0.571429em;vertical-align:baseline}[data-component-part=\"accordion-description\"]{font-size:0.875rem!important}.accordion.mb-3{margin-bottom:0.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:bold}.sql-grammar svg text.nonterminal{font-family:Verdana, Sans-serif;font-size:12px;fill:#0055FF}.sql-grammar svg text.regexp{font-family:Verdana, Sans-serif;font-size:12px;fill:#0F0F0F}.sql-grammar svg rect,.sql-grammar svg circle,.sql-grammar svg polygon{fill:#262626;stroke:#262626}.sql-grammar svg rect.terminal{fill:#ffffff;stroke:#262626}.sql-grammar svg rect.nonterminal{fill:#FFFFFF;stroke:#262626}.sql-grammar svg rect.text{fill:none;stroke:none}.sql-grammar svg polygon.regexp{fill:#FFFFFF;stroke:#262626}.sql-grammar svg{background-color:#ffffff}.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}"},{"filePath":"collapse-nav.css","content":"html:not(.crl-nav-off) [data-layout-item=\"sidebar\"] li[data-title]:not([data-active]):not([data-crl-keep])>button+ul,html:not(.crl-nav-off) [data-layout-item=\"mobile-nav\"] li[data-title]:not([data-active]):not([data-crl-keep])>button+ul{display:none}html:not(.crl-nav-off) [data-layout-item=\"sidebar\"] li[data-title]:not([data-active]):not([data-crl-keep])>button svg,html:not(.crl-nav-off) [data-layout-item=\"mobile-nav\"] li[data-title]:not([data-active]):not([data-crl-keep])>button svg{rotate:none!important;transform:none!important}"}],"page":{"pagePath":"docs/api/cluster/v2/list-sessions","slug":"/docs/api/cluster/v2/list-sessions","pageMetadata":{"title":"List sessions","description":"List all sessions on this cluster. If a username is provided, only\nsessions from that user are returned.\n\nClient must be logged in as a user with admin privileges.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"List all sessions on this cluster. If a username is provided, only\\nsessions from that user are returned.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Client must be logged in as a user with admin privileges.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"config":{},"pageMetadata":{"title":"List sessions","description":"List all sessions on this cluster. If a username is provided, only\nsessions from that user are returned.\n\nClient must be logged in as a user with admin privileges.","deprecated":null,"version":null,"openapi":"/openapi/cluster-api-v2.json get /sessions/","href":"/docs/api/cluster/v2/list-sessions","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cockroachlabs/4695317e415d4eba/kapa.js","/_mintlify/custom/cockroachlabs/40fb45a3cfe42c92/copy-code-prompt.js","/_mintlify/custom/cockroachlabs/3f343c9e8c40397a/collapse-nav.js"],"openApiReferenceData":{"operation":{"security":["e8f5bfd1-bd7b-4d4c-ac99-1c44e149b938"],"description":"List all sessions on this cluster. If a username is provided, only\nsessions from that user are returned.\n\nClient must be logged in as a user with admin privileges.","summary":"List sessions","operationId":"listSessions","parameters":["24a5c776-a3e3-415a-9ec4-6ff66e58062e","d7fa9529-5afb-4f76-8820-986f7ce0ac57","384aa3c9-fb59-4955-8e87-2010d690ab61"],"responses":{"200":"a13a1c56-e3d2-4299-a638-511d7dfd9978"},"x-codeSamples":[{"lang":"curl","source":"curl --request GET \\\n --url 'https://localhost/api/v2/sessions/?username=SOME_STRING_VALUE\u0026limit=SOME_INTEGER_VALUE\u0026start=SOME_STRING_VALUE' \\\n --header 'X-Cockroach-API-Session: REPLACE_KEY_VALUE'"}],"method":"get","type":"path","servers":["04788cf5-fe5d-4355-a8b6-24da474d06b5","ae258676-2265-4498-8347-e3871ff462ed"],"path":"/sessions/","baseUrlOptions":["https://localhost/api/v2","http://localhost/api/v2"],"title":"List sessions","codeSamples":[{"lang":"curl","source":"curl --request GET \\\n --url 'https://localhost/api/v2/sessions/?username=SOME_STRING_VALUE\u0026limit=SOME_INTEGER_VALUE\u0026start=SOME_STRING_VALUE' \\\n --header 'X-Cockroach-API-Session: REPLACE_KEY_VALUE'"}],"requestExampleLanguages":["bash"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"24a5c776-a3e3-415a-9ec4-6ff66e58062e":{"description":"Username of user to return sessions for; if unspecified, sessions from all users are returned.","name":"username","in":"query","schema":{"type":"string","description":"Username of user to return sessions for; if unspecified, sessions from all users are returned.","uniqueKey":"","typeLabel":"string"}},"d7fa9529-5afb-4f76-8820-986f7ce0ac57":{"description":"Maximum number of results to return in this call.","name":"limit","in":"query","schema":{"type":"integer","description":"Maximum number of results to return in this call.","uniqueKey":"","typeLabel":"integer"}},"384aa3c9-fb59-4955-8e87-2010d690ab61":{"description":"Continuation token for results after a past limited run.","name":"start","in":"query","schema":{"type":"string","description":"Continuation token for results after a past limited run.","uniqueKey":"","typeLabel":"string"}}},"responses":{"a13a1c56-e3d2-4299-a638-511d7dfd9978":{"description":"List sessions response.","content":{"application/json":{"schema":{"type":"object","title":"Response for listSessions.","properties":{"errors":{"description":"Any errors that occurred during fan-out calls to other nodes.","type":"array","items":{"type":"object","title":"An error wrapper object for ListSessionsResponse.","properties":{"message":{"description":"Error message.","type":"string","x-go-name":"Message","uniqueKey":"errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"description":"A custom type for a cockroach node ID. (not a raft node ID)\n0 is not a valid NodeID.","type":"integer","format":"int32","x-go-package":"github.com/cockroachdb/cockroach/pkg/roachpb","uniqueKey":"errors.items.[INDEX].node_id","typeLabel":"integer\u003cint32>"}},"x-go-package":"github.com/cockroachdb/cockroach/pkg/server/serverpb","uniqueKey":"errors.items.[INDEX]","typeLabel":"An error wrapper object for ListSessionsResponse. · object"},"x-go-name":"Errors","uniqueKey":"errors","typeLabel":"An error wrapper object for ListSessionsResponse. · object[]"},"next":{"description":"The continuation token, for use in the next paginated call in the `start`\nparameter.","type":"string","x-go-name":"Next","uniqueKey":"next","typeLabel":"string"},"sessions":{"description":"A list of sessions on this node or cluster.","type":"array","items":{"type":"object","title":"Session represents one SQL session.","properties":{"active_queries":{"description":"Queries in progress on this session.","type":"array","items":{"type":"object","title":"A query in flight on a session.","properties":{"id":{"description":"ID of the query (uint128 presented as a hexadecimal string).","type":"string","x-go-name":"ID","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].id","typeLabel":"string"},"is_distributed":{"description":"True if this query is distributed.","type":"boolean","x-go-name":"IsDistributed","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].is_distributed","typeLabel":"boolean"},"phase":{"type":"integer","format":"int32","title":"Phase of execution: `0` for PREPARING, `1` for EXECUTING. For more information see the doc \"SHOW QUERIES\".","x-go-package":"github.com/cockroachdb/cockroach/pkg/server/serverpb","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].phase","typeLabel":"integer\u003cint32>"},"progress":{"description":"An estimate of the fraction of this query that has been\nprocessed.","type":"number","format":"float","x-go-name":"Progress","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].progress","typeLabel":"number\u003cfloat>"},"sql":{"description":"SQL query string specified by the user.","type":"string","x-go-name":"Sql","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].sql","typeLabel":"string"},"sql_no_constants":{"description":"The SQL statement fingerprint, compatible with StatementStatisticsKey.","type":"string","x-go-name":"SqlNoConstants","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].sql_no_constants","typeLabel":"string"},"start":{"description":"Start timestamp of this query.","type":"string","format":"date-time","x-go-name":"Start","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].start","typeLabel":"string\u003cdate-time>"},"txn_id":{"type":"array","title":"An array type to represent the value of a UUID, as defined in RFC-4122.","items":{"type":"integer","format":"uint8","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].txn_id.items.[INDEX]","typeLabel":"integer\u003cuint8>"},"x-go-package":"github.com/cockroachdb/cockroach/pkg/util/uuid","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX].txn_id","typeLabel":"integer\u003cuint8>[]"}},"x-go-package":"github.com/cockroachdb/cockroach/pkg/server/serverpb","uniqueKey":"sessions.items.[INDEX].active_queries.items.[INDEX]","typeLabel":"A query in flight on a session. · object"},"x-go-name":"ActiveQueries","uniqueKey":"sessions.items.[INDEX].active_queries","typeLabel":"A query in flight on a session. · object[]"},"active_txn":{"type":"object","title":"Represents an in-flight user transaction on a session. This is for internal Cockroach Labs use.","properties":{"alloc_bytes":{"description":"Number of currently allocated bytes in the transaction memory monitor.","type":"integer","format":"int64","x-go-name":"AllocBytes","uniqueKey":"sessions.items.[INDEX].active_txn.alloc_bytes","typeLabel":"integer\u003cint64>"},"deadline":{"description":"The deadline by which the transaction must be committed.","type":"string","format":"date-time","x-go-name":"Deadline","uniqueKey":"sessions.items.[INDEX].active_txn.deadline","typeLabel":"string\u003cdate-time>"},"id":{"type":"array","title":"An array type to represent the value of a UUID, as defined in RFC-4122.","items":{"type":"integer","format":"uint8","uniqueKey":"sessions.items.[INDEX].active_txn.id.items.[INDEX]","typeLabel":"integer\u003cuint8>"},"x-go-package":"github.com/cockroachdb/cockroach/pkg/util/uuid","uniqueKey":"sessions.items.[INDEX].active_txn.id","typeLabel":"integer\u003cuint8>[]"},"implicit":{"description":"Implicit is true if this transaction was an implicit SQL transaction.","type":"boolean","x-go-name":"Implicit","uniqueKey":"sessions.items.[INDEX].active_txn.implicit","typeLabel":"boolean"},"is_historical":{"type":"boolean","x-go-name":"IsHistorical","uniqueKey":"sessions.items.[INDEX].active_txn.is_historical","typeLabel":"boolean"},"max_alloc_bytes":{"description":"High water mark of allocated bytes in the txn memory monitor.","type":"integer","format":"int64","x-go-name":"MaxAllocBytes","uniqueKey":"sessions.items.[INDEX].active_txn.max_alloc_bytes","typeLabel":"integer\u003cint64>"},"num_auto_retries":{"description":"The number of times that this transaction was automatically\nretried by the SQL executor.","type":"integer","format":"int32","x-go-name":"NumAutoRetries","uniqueKey":"sessions.items.[INDEX].active_txn.num_auto_retries","typeLabel":"integer\u003cint32>"},"num_retries":{"description":"The number of times that this transaction was retried.","type":"integer","format":"int32","x-go-name":"NumRetries","uniqueKey":"sessions.items.[INDEX].active_txn.num_retries","typeLabel":"integer\u003cint32>"},"num_statements_executed":{"description":"The number of statements that were executed so\nfar on this transaction.","type":"integer","format":"int32","x-go-name":"NumStatementsExecuted","uniqueKey":"sessions.items.[INDEX].active_txn.num_statements_executed","typeLabel":"integer\u003cint32>"},"priority":{"type":"string","x-go-name":"Priority","uniqueKey":"sessions.items.[INDEX].active_txn.priority","typeLabel":"string"},"read_only":{"type":"boolean","x-go-name":"ReadOnly","uniqueKey":"sessions.items.[INDEX].active_txn.read_only","typeLabel":"boolean"},"start":{"description":"The start timestamp of the transaction.","type":"string","format":"date-time","x-go-name":"Start","uniqueKey":"sessions.items.[INDEX].active_txn.start","typeLabel":"string\u003cdate-time>"},"txn_description":{"description":"A text description of the underlying kv.Txn, intended\nfor troubleshooting purposes.","type":"string","x-go-name":"TxnDescription","uniqueKey":"sessions.items.[INDEX].active_txn.txn_description","typeLabel":"string"}},"x-go-package":"github.com/cockroachdb/cockroach/pkg/server/serverpb","uniqueKey":"sessions.items.[INDEX].active_txn","typeLabel":"Represents an in-flight user transaction on a session. This is for internal Cockroach Labs use. · object"},"alloc_bytes":{"description":"Number of currently allocated bytes in the session memory monitor.","type":"integer","format":"int64","x-go-name":"AllocBytes","uniqueKey":"sessions.items.[INDEX].alloc_bytes","typeLabel":"integer\u003cint64>"},"application_name":{"description":"Application name specified by the client.","type":"string","x-go-name":"ApplicationName","uniqueKey":"sessions.items.[INDEX].application_name","typeLabel":"string"},"client_address":{"description":"Connected client's IP address and port.","type":"string","x-go-name":"ClientAddress","uniqueKey":"sessions.items.[INDEX].client_address","typeLabel":"string"},"id":{"description":"ID of the session (uint128 represented as raw bytes).","type":"array","items":{"type":"integer","format":"uint8","uniqueKey":"sessions.items.[INDEX].id.items.[INDEX]","typeLabel":"integer\u003cuint8>"},"x-go-name":"ID","uniqueKey":"sessions.items.[INDEX].id","typeLabel":"integer\u003cuint8>[]"},"last_active_query":{"description":"SQL string of the last query executed on this session.","type":"string","x-go-name":"LastActiveQuery","uniqueKey":"sessions.items.[INDEX].last_active_query","typeLabel":"string"},"last_active_query_no_constants":{"description":"SQL statement fingerprint of the last query executed on this session,\ncompatible with StatementStatisticsKey.","type":"string","x-go-name":"LastActiveQueryNoConstants","uniqueKey":"sessions.items.[INDEX].last_active_query_no_constants","typeLabel":"string"},"max_alloc_bytes":{"description":"High water mark of allocated bytes in the session memory monitor.","type":"integer","format":"int64","x-go-name":"MaxAllocBytes","uniqueKey":"sessions.items.[INDEX].max_alloc_bytes","typeLabel":"integer\u003cint64>"},"node_id":{"description":"A custom type for a cockroach node ID. (not a raft node ID)\n0 is not a valid NodeID.","type":"integer","format":"int32","x-go-package":"github.com/cockroachdb/cockroach/pkg/roachpb","uniqueKey":"sessions.items.[INDEX].node_id","typeLabel":"integer\u003cint32>"},"start":{"description":"Timestamp of session's start.","type":"string","format":"date-time","x-go-name":"Start","uniqueKey":"sessions.items.[INDEX].start","typeLabel":"string\u003cdate-time>"},"username":{"description":"Username of the user for this session.","type":"string","x-go-name":"Username","uniqueKey":"sessions.items.[INDEX].username","typeLabel":"string"}},"x-go-package":"github.com/cockroachdb/cockroach/pkg/server/serverpb","uniqueKey":"sessions.items.[INDEX]","typeLabel":"Session represents one SQL session. · object"},"x-go-name":"Sessions","uniqueKey":"sessions","typeLabel":"Session represents one SQL session. · object[]"}},"x-go-name":"listSessionsResponse","x-go-package":"github.com/cockroachdb/cockroach/pkg/server","uniqueKey":"","typeLabel":"Response for listSessions. · object"},"examples":{"Example":{"title":"Example","value":{"errors":[{"message":"\u003cstring>","node_id":123}],"next":"\u003cstring>","sessions":[{"active_queries":[{"id":"\u003cstring>","is_distributed":true,"phase":123,"progress":123,"sql":"\u003cstring>","sql_no_constants":"\u003cstring>","start":"2023-11-07T05:31:56Z","txn_id":[123]}],"active_txn":{"alloc_bytes":123,"deadline":"2023-11-07T05:31:56Z","id":[123],"implicit":true,"is_historical":true,"max_alloc_bytes":123,"num_auto_retries":123,"num_retries":123,"num_statements_executed":123,"priority":"\u003cstring>","read_only":true,"start":"2023-11-07T05:31:56Z","txn_description":"\u003cstring>"},"alloc_bytes":123,"application_name":"\u003cstring>","client_address":"\u003cstring>","id":[123],"last_active_query":"\u003cstring>","last_active_query_no_constants":"\u003cstring>","max_alloc_bytes":123,"node_id":123,"start":"2023-11-07T05:31:56Z","username":"\u003cstring>"}]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"e8f5bfd1-bd7b-4d4c-ac99-1c44e149b938":{"api_session":{"description":"Token for logged-in REST session. Use `/login/` to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.","type":"apiKey","name":"X-Cockroach-API-Session","in":"header","scopes":[]}}},"servers":{"04788cf5-fe5d-4355-a8b6-24da474d06b5":{"url":"https://localhost/api/v2"},"ae258676-2265-4498-8347-e3871ff462ed":{"url":"http://localhost/api/v2"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"description":"Token for logged-in REST session. Use `/login/` to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.","type":"apiKey","name":"X-Cockroach-API-Session","in":"header","scopes":[]},"schema":{"title":"X-Cockroach-API-Session","type":"string","description":"Token for logged-in REST session. Use `/login/` to log in and get a session token. For additional information, see cockroachlabs.com/docs/stable/cluster-api.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"api_session","name":"X-Cockroach-API-Session"}],"title":"api_session"}]},"originalFileLocation":"openapi/cluster-api-v2.json"},"subdomain":"cockroachlabs","siteName":"CockroachDB","title":"List sessions - CockroachDB","navMaps":{"firstHrefInVersion":{"v26.4":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v26.3":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v26.2":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v26.1":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v25.4":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v25.3":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v25.2":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v25.1":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v24.3":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v24.1":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v23.2":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0},"v23.1":{"href":"/docs/api/cluster/v2/list-sessions","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-07-15T10:02:19.265Z","originalFileLocation":"docs/api/cluster/v2/list-sessions.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=\"description\" content=\"List all sessions on this cluster. If a username is provided, only sessions from that user are returned. Client must be logged in as a user with admin privileges.\">\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=\"List sessions - CockroachDB\">\u003cmeta data-mint-head property=\"og:description\" content=\"List all sessions on this cluster. If a username is provided, only sessions from that user are returned. Client must be logged in as a user with admin privileges.\">\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/v2/list-sessions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cockroachlabs.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=List+sessions\u0026amp;description=List+all+sessions+on+this+cluster.+If+a+username+is+provided%2C+only%0Asessions+from+that+user+are+returned.%0A%0AClient+must+be+logged+in+as+a+user+with+admin+privileg\u0026amp;theme=4aeed7318cb28bd50868adb3\u0026amp;signature=d32ddec836853f404a2386b1c2cf9b5b6815fec4754c46935dfe31a50ce217c7\">\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=\"List sessions - CockroachDB\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"List all sessions on this cluster. If a username is provided, only sessions from that user are returned. Client must be logged in as a user with admin privileges.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cockroachlabs.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=List+sessions\u0026amp;description=List+all+sessions+on+this+cluster.+If+a+username+is+provided%2C+only%0Asessions+from+that+user+are+returned.%0A%0AClient+must+be+logged+in+as+a+user+with+admin+privileg\u0026amp;theme=4aeed7318cb28bd50868adb3\u0026amp;signature=d32ddec836853f404a2386b1c2cf9b5b6815fec4754c46935dfe31a50ce217c7\">\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/v2/list-sessions\">\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/v2/list-sessions.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/v2/list-sessions#webpage\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions\",\"name\":\"List sessions\",\"description\":\"List all sessions on this cluster. If a username is provided, only sessions from that user are returned. Client must be logged in as a user with admin privileges.\",\"dateModified\":\"2026-07-15T10:02:19.265Z\",\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-databases\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-databases\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"List sessions\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions#apireference\",\"headline\":\"List sessions\",\"name\":\"List sessions\",\"description\":\"List all sessions on this cluster. If a username is provided, only sessions from that user are returned. Client must be logged in as a user with admin privileges.\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cluster/v2/list-sessions#webpage\"},\"dateModified\":\"2026-07-15T10:02:19.265Z\",\"publisher\":{\"@id\":\"https://docs.cockroachlabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"}}]}\u003c/script>","agentPointerHref":"/docs/api/cluster/v2/list-sessions.md","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","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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.3","tabs":[{"tab":"Docs","icon":"book-open","pages":[{"title":"Docs","href":"/docs/v26.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/v26.3/sql-statements"}]},{"tab":"Reference","icon":"book","pages":[{"title":"Reference","href":"/docs/v26.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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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.3/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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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","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","description":"Retrieve more information about a specific range.\n\nClient must be logged in as a user with admin privileges.","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","description":"List SQL users on this cluster.","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"}]}]},"basePath":"","title":"List sessions - CockroachDB","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CybtLBIt.js","utils-BMLj2fvV.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-B6In562Y.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dr8Mfhp9.js","snippetPresets-2rmQvMVl.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-WMqJYdZj.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CJ-MlPHu.js","shallow-dY3TMRCk.js","getApiPlaygroundDisplay-v-1B2bKm.js","CodeSnippet-BDhiTB7U.js","CodeSnippets-D9hnzQcS.js","Page-C4GwDT3_.js","getPastedJson-Th2V45jI.js","icon-BQXch1W9.js","MethodPill-BCqUneP3.js","DuplicateIcon-Q_-bhurZ.js","createIcon-DUjLHRqp.js","DynamicMarkdown-B-f2cqXQ.js","SectionHeading-Da5NsV4v.js","axios-vUo_bRtp.js","Markdown-D13FWkIM.js","clsx-D3Isdib3.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-C-XZBk9h.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink--qIqmmVG.js"]}