RuntimeScanningInfo describes the runtime scanning configuration of a cluster.
It is returned by the get, enable, and disable runtime scanning endpoints.
NONE: NONE indicates runtime scanning is disabled; no agent is enforced.
WIZ: WIZ indicates runtime scanning is enforced using the Wiz agent.
Available options:
NONE,
WIZ
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CockroachDB","colors":{"primary":"#9059FF","light":"#9059FF","dark":"#9059FF"},"logo":{"light":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_Black.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=54ccae625c9986bf1df8ddc7b2c571f0","dark":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_White.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=0dd9b66973a1c7d3dd72aa67b6094efe","href":"https://www.cockroachlabs.com/"},"favicon":{"light":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551","dark":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551"},"api":{"examples":{"defaults":"required","languages":["curl"]}},"appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Get started free","href":"https://cockroachlabs.cloud/signup?referralId=cc_nav_global\u0026_ga=2.242886210.1147139380.1759903632-41552699.1759903632"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@cockroachdb","x":"https://x.com/CockroachDB","linkedin":"https://www.linkedin.com/company/cockroach-labs/mycompany/verification","instagram":"https://www.instagram.com/cockroachdb"},"links":[{"header":"Product","items":[{"label":"CockroachDB","href":"https://www.cockroachlabs.com/product"},{"label":"CockroachDB Cloud","href":"https://www.cockroachlabs.com/product/cockroachcloud"},{"label":"Compare","href":"https://www.cockroachlabs.com/compare"},{"label":"Pricing","href":"https://www.cockroachlabs.com/pricing"},{"label":"Get CockroachDB","href":"https://www.cockroachlabs.com/get-started-cockroachdb"},{"label":"Sign In","href":"https://cockroachlabs.cloud/"}]},{"header":"Resources","items":[{"label":"Guides","href":"https://resources.cockroachlabs.com/guides"},{"label":"Webinars","href":"https://www.cockroachlabs.com/community/webinars"},{"label":"Videos","href":"https://www.cockroachlabs.com/resources/video"},{"label":"Architecture Overview","href":"https://www.cockroachlabs.com/docs/stable/architecture/overview"},{"label":"FAQ","href":"https://www.cockroachlabs.com/docs/stable/frequently-asked-questions"},{"label":"Security","href":"https://www.cockroachlabs.com/security"}]},{"header":"Learn \u0026 Support","items":[{"label":"Docs","href":"https://www.cockroachlabs.com/docs"},{"label":"University","href":"https://learn.cockroachlabs.com/"},{"label":"Developers","href":"https://www.cockroachlabs.com/developers"},{"label":"Forum","href":"https://forum.cockroachlabs.com/"},{"label":"Slack","href":"https://cockroa.ch/slack"},{"label":"Support Portal","href":"https://support.cockroachlabs.com/hc/en-us"},{"label":"Contact Us","href":"https://www.cockroachlabs.com/contact"}]},{"header":"Company","items":[{"label":"About","href":"https://www.cockroachlabs.com/about"},{"label":"Blog","href":"https://www.cockroachlabs.com/blog"},{"label":"Careers","href":"https://www.cockroachlabs.com/careers"},{"label":"Customers","href":"https://www.cockroachlabs.com/customers"},{"label":"News","href":"https://www.cockroachlabs.com/press"},{"label":"Privacy","href":"https://www.cockroachlabs.com/privacy"},{"label":"Terms of Use","href":"https://www.cockroachlabs.com/website-terms-of-use"}]}]},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Open Sans"}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"latex":true},"integrations":{"gtm":{"tagId":"GTM-NR8LC4"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. [Return to docs home](/index.html)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cockroachlabs","hasAudioNarration":false,"actualSubdomain":"cockroachlabs","customDomains":["docs.cockroachlabs.com"],"gitSource":{"type":"github","owner":"cockroachlabs","repo":"docs","deployBranch":"main","contentDirectory":"cockroachlabs-preview-main","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6adc24f9d1a26b8362e3268c","collectionId":"7d02ecdd-010f-452c-a839-1542479b4ee8","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6adc24f9d1a26b8362e3268c"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6adc24f9d1a26b8362e3268c","clientVersion":"0.0.3966","searchFilterCounts":[{"language":"default","tag":"CockroachDB","count":6968},{"language":"default","tag":"Docs","count":3238},{"language":"default","tag":"SQL","count":2562},{"language":"default","tag":"Statements","count":1710},{"language":"default","tag":"Self-Hosted Deployments","count":1479},{"language":"default","tag":"Reference","count":774},{"language":"default","tag":"Cloud Deployments","count":616},{"language":"default","tag":"Endpoints","count":528},{"language":"default","tag":"Cloud API Reference","count":518},{"language":"default","tag":"Get Started","count":441}],"searchSettings":{"isFiltersEnabled":false}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-v7-file-tree","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-nav-generations","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--inline-code-bg-light:rgb(var(--gray-200) / 0.92);--inline-code-bg-dark:rgb(255 255 255 / 0.08)}.prose :not(pre)>code{background-color:var(--inline-code-bg-light)!important}.dark .prose :not(pre)>code{background-color:var(--inline-code-bg-dark)!important}@media (min-width:1536px){#navbar>.max-w-8xl,[class*=\"peer-[.is-not-custom]:peer-[.is-not-center]:max-w-8xl\"]{width:100%!important;max-width:none!important}}#navigation-items{display:flex;flex-direction:column}#navigation-items>ul:not(.sidebar-group){order:1;margin-top:1.5rem}.crdb-fixed-table table,.crdb-metrics-table table{table-layout:fixed!important;width:100%!important;min-width:0!important;max-width:100%!important;border-collapse:collapse}.crdb-fixed-table table td,.crdb-fixed-table table th,.crdb-metrics-table table td,.crdb-metrics-table table th{min-width:0!important;overflow-wrap:anywhere;word-break:break-word}.bg-cover{background-size:cover;background-repeat:no-repeat;background-position:center center}.bg-cover__bg-3-1{background-image:url(https://cockroach-labs-docs.imgix.net/bg-3-1.png?auto=format,compress\u0026w=1200\u0026q=40)}.home-header{border-radius:.5rem;margin-bottom:2rem!important;padding:2rem}.card{border:1px solid #e5e7eb;border-radius:.75rem;background-color:#fff}.dark .card{background-color:#0d1117;border-color:rgba(255,255,255,.1)}.card-link,.card-link:hover{transform:none!important;box-shadow:none!important}.card-link{text-decoration:none!important;overflow:hidden}.card-link:hover{outline:1px solid rgba(105,51,255,.55);outline-offset:-1px}.card-link a,.card-link a:hover,.card-link h3,.card-link h3:hover,.card-link p,.card-link p:hover{border:0!important;text-decoration:none!important;transform:none!important}.card-link a{display:block;width:100%}.card-link h3{font-size:1rem!important;font-weight:600!important}.card-body{padding:1.5rem}.landing-column-title{margin-bottom:1rem}.article-lists h3,.overline{text-transform:uppercase;letter-spacing:.05em}.btn-redirect{display:inline-flex;align-items:center;gap:.5rem;padding:.75rem 1.5rem;border:2px solid #e5e7eb;border-radius:.5rem;text-decoration:none;transition:border-color .2s}.btn-redirect:hover{border-color:#6933ff}.btn-block{display:flex;width:100%;justify-content:center}.dark .btn-redirect{border-color:rgba(255,255,255,.1)}.article-section-title{font-size:1.25rem!important}.article-lists h3{font-size:.875rem!important;font-weight:600!important;color:#6b7280!important}.dark .article-lists h3,.dark .card-link .card-desc{color:#9ca3af!important}.article-lists ul{font-size:.875rem}.shadow{box-shadow:0 .5rem 1rem rgba(0,0,0,.15)}.bg-dark-wing{background-color:#152849;border-radius:.5rem}.text-ice-temple{color:#1bf8ec!important;display:inline-flex;align-items:center;gap:.375rem}.text-ice-temple img{display:inline-block;margin:0}.bg-dark-wing h2{font-size:clamp(1.25rem,1rem + 1.5vw,1.75rem)!important}@media (max-width:576px){.card-body.bg-dark-wing{padding:1.25rem!important}}.text-decoration-none{text-decoration:none!important}.text-muted{color:#6b7280!important}.card-link .card-desc{font-size:.9375rem!important;font-weight:400!important;line-height:1.5!important;text-align:left!important;color:#4b5563!important;width:100%;margin-top:.5rem}.report-tag{display:inline-block;padding:.25rem .75rem;border-radius:.25rem;background-color:rgba(84,42,189,.08);color:#542abd}.dark .report-tag{background-color:rgba(84,42,189,.3);color:#b39dff}.resilience-report-img{background-image:url(/images/state-resilience.png);background-size:cover;background-position:center;min-height:150px;border-radius:.5rem}.row{flex-wrap:wrap;margin-left:-.75rem;margin-right:-.75rem}.display-flex,.row{display:flex!important}.col-lg-4{flex:0 0 auto;width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-4{width:33.333333%!important}}.col-lg-3,.col-sm-6,.col-xs-12{flex:0 0 auto;width:100%!important;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-3{width:25%!important}}@media (min-width:576px){.col-sm-6{width:50%!important}}.col-12{width:100%!important}.col-lg-12{width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:992px){.col-lg-12{width:100%!important}}.col-md-4,.col-md-8{flex:0 0 auto;width:100%;padding-left:.75rem;padding-right:.75rem}@media (min-width:768px){.col-md-4{width:33.333333%!important}.col-md-8{width:66.666667%!important}}.h-100{height:100%}.d-flex{display:flex}.flex-column{flex-direction:column}.mb-3{margin-bottom:1rem!important}.mb-5{margin-bottom:3rem!important}.pb-5{padding-bottom:3rem!important}.mb-xl-5{margin-bottom:3rem!important}.mt-auto{margin-top:auto!important}.mt-0{margin-top:0!important}.mt-2{margin-top:.5rem!important}.mt-3{margin-top:1rem!important}.mt-5:not(.code-block){margin-top:3rem!important}.code-block.mb-8{margin-bottom:calc(var(--spacing)*5)}.pt-5{padding-top:3rem!important}.m-0{margin:0!important}.ml-2{margin-left:.5rem!important}.mb-0{margin-bottom:0!important}.mb-2{margin-bottom:.5rem!important}.mb-4{margin-bottom:1.5rem!important}.p-2{padding:.5rem!important}.p-3{padding:1rem!important}.p-4{padding:1.5rem!important}.pb-3{padding-bottom:1rem!important}.pb-4{padding-bottom:1.5rem!important}.ml-1{margin-left:.25rem!important}.mr-auto{margin-right:auto!important}.justify-content-center{justify-content:center!important}.align-items-center{align-items:center!important}@media (min-width:1200px){.p-xl-5{padding:3rem!important}}.mx-0{margin-left:0!important;margin-right:0!important}.text-center{text-align:center}.dark .text-black,.text-white{color:#fff!important}.text-black{color:#000!important}.container{width:100%;max-width:1200px;margin-left:auto;margin-right:auto;padding-left:1rem;padding-right:1rem}.card-header-overlap-text{position:relative}@media (min-width:768px){.p-md-5{padding:3rem!important}}@media (min-width:992px){.d-lg-flex{display:flex!important}.mb-lg-0{margin-bottom:0!important}}.prose table{border-collapse:collapse!important}.prose table td,.prose table th{border:1px solid rgb(var(--gray-200))!important}.dark .prose table td,.dark .prose table th{border-color:rgb(var(--gray-700)/.5)!important}.prose table th{padding:.571429em;font-weight:600;vertical-align:bottom;color:var(--tw-prose-headings);text-align:left}.prose table th.center-align{text-align:center}.prose table td{padding:.571429em;vertical-align:baseline}[data-component-part=accordion-description]{font-size:.875rem!important}.accordion.mb-3{margin-bottom:.25rem!important}@media (max-width:991.98px){[id^=kapa-widget-container] button{width:36px!important;height:36px!important;min-width:36px!important;padding:0!important;font-size:0!important}[id^=kapa-widget-container] button svg{width:18px!important;height:18px!important}[id^=kapa-widget-container] button span{display:none!important}}table.crdb-fixed-table{table-layout:fixed!important;min-width:0!important;width:100%}table.crdb-fixed-table td,table.crdb-fixed-table th{min-width:0!important;overflow-wrap:break-word;word-break:normal}.sql-grammar svg .line{fill:none;stroke:#262626}.sql-grammar svg .bold-line{stroke:#0a0a0a;shape-rendering:crispEdges;stroke-width:2}.sql-grammar svg .thin-line{stroke:#0f0f0f;shape-rendering:crispEdges}.sql-grammar svg .filled{fill:#262626;stroke:none}.sql-grammar svg text.terminal{font-family:Verdana,Sans-serif;font-size:12px;fill:#0a0a0a;font-weight:700}.sql-grammar svg text.nonterminal,.sql-grammar svg text.regexp{font-family:Verdana,Sans-serif;font-size:12px;fill:#05f}.sql-grammar svg text.regexp{fill:#0f0f0f}.sql-grammar svg circle,.sql-grammar svg polygon,.sql-grammar svg rect{fill:#262626;stroke:#262626}.sql-grammar svg polygon.regexp,.sql-grammar svg rect.nonterminal,.sql-grammar svg rect.terminal{fill:#fff;stroke:#262626}.sql-grammar svg rect.text{fill:none;stroke:none}.sql-grammar svg{background-color:#fff}.sql-grammar a[name]::before{content:'';display:block;height:80px;margin:-80px 0 0}.sql-grammar a[name]:focus{outline:0}pre[language=sql][data-crdb-prompt-stripped] code::before{content:\"> \";color:#94e2d5;user-select:none}.mark-yes{color:#008a5e;font-weight:600}.dark .mark-yes{color:#3ddc97}"}],"page":{"pagePath":"docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster","slug":"/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster","pageMetadata":{"title":"Disable runtime scanning on a cluster.","description":"Can be used by the following roles assigned at the organization, folder or cluster scope:\n- CLUSTER_ADMIN\n- CLUSTER_OPERATOR_WRITER\n","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster","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 li: \"li\",\n p: \"p\",\n ul: \"ul\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Can be used by the following roles assigned at the organization, folder or cluster scope:\"\n }), \"\\n\", _jsxs(_components.ul, {\n children: [\"\\n\", _jsx(_components.li, {\n children: \"CLUSTER_ADMIN\"\n }), \"\\n\", _jsx(_components.li, {\n children: \"CLUSTER_OPERATOR_WRITER\"\n }), \"\\n\"]\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,strong:`strong`,..._provideComponents(),...props.components},{Warning}=_components;if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsx(`span`,{style:{backgroundColor:`#fee2e2`,color:`#b91c1c`,borderRadius:`9999px`,padding:`2px 10px`,fontSize:`12px`,fontWeight:`600`,letterSpacing:`0.5px`,display:`inline-block`},children:`LIMITED ACCESS`}),`\n`,_jsxs(Warning,{children:[`This endpoint is in `,_jsx(_components.strong,{children:`Limited Access`}),` and may not be available to all users. Refer to the `,_jsx(_components.a,{href:`https://docs.cockroachlabs.com/docs/stable/api-support-policy`,children:`API support policy`}),` for more details.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"config":{},"pageMetadata":{"title":"Disable runtime scanning on a cluster.","description":"Can be used by the following roles assigned at the organization, folder or cluster scope:\n- CLUSTER_ADMIN\n- CLUSTER_OPERATOR_WRITER\n","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cockroachlabs/4695317e415d4eba/kapa.js","/_mintlify/custom/cockroachlabs/40fb45a3cfe42c92/copy-code-prompt.js"],"openApiReferenceData":{"operation":{"operationId":"CockroachCloud_DisableClusterRuntimeScanning","summary":"Disable runtime scanning on a cluster.","description":"Can be used by the following roles assigned at the organization, folder or cluster scope:\n- CLUSTER_ADMIN\n- CLUSTER_OPERATOR_WRITER\n","parameters":["d330a621-aa24-47e7-9879-fd32c632d464"],"responses":{"200":"9c2419d8-2127-4971-8bbc-478e115a5653","400":"52983094-df9b-418b-a0f9-c92f3a2be926","401":"3f678130-0942-4235-8dca-53e3be8e117a","403":"e2557ea7-56bb-48a8-b7de-d46d0849ae99","404":"a5a041a4-e7d5-423d-8cc1-23d2fa2cf689","500":"50ba26dd-7ee1-4fd1-a672-d563f22b779f","default":"af9830aa-6f0d-4152-a638-1b95c48fa94a"},"tags":["Runtime Scanning"],"x-badges":[{"color":"red","label":"LIMITED ACCESS"}],"x-codeSamples":[{"lang":"curl","source":"curl --request DELETE \\\n --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"}],"x-mint":{"metadata":{"tag":"Limited Access"},"content":"\u003cspan style={{ backgroundColor: \"#fee2e2\", color: \"#b91c1c\", borderRadius: \"9999px\", padding: \"2px 10px\", fontSize: \"12px\", fontWeight: \"600\", letterSpacing: \"0.5px\", display: \"inline-block\" }}>LIMITED ACCESS\u003c/span>\n\n\u003cWarning>This endpoint is in **Limited Access** and may not be available to all users. Refer to the [API support policy](https://docs.cockroachlabs.com/docs/stable/api-support-policy) for more details.\u003c/Warning>"},"method":"delete","type":"path","servers":["16c3f5cc-d364-4ff7-a7fe-b80ba8ccccd4"],"security":["bc452480-13bf-486e-9961-c443e714ceac"],"path":"/api/v1/clusters/{cluster_id}/runtime-scanning","baseUrlOptions":["https://cockroachlabs.cloud"],"title":"Disable runtime scanning on a cluster.","codeSamples":[{"lang":"curl","source":"curl --request DELETE \\\n --url https://cockroachlabs.cloud/api/v1/clusters/{cluster_id}/runtime-scanning \\\n --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'"}],"requestExampleLanguages":["bash"],"requiredOnlyExamples":true,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"d330a621-aa24-47e7-9879-fd32c632d464":{"name":"cluster_id","in":"path","description":"cluster_id is the ID of the cluster.","required":true,"schema":{"type":"string","isRequired":true,"description":"cluster_id is the ID of the cluster.","uniqueKey":"","typeLabel":"string"}}},"responses":{"9c2419d8-2127-4971-8bbc-478e115a5653":{"description":"A successful response.","content":{"application/json":{"schema":{"description":"RuntimeScanningInfo describes the runtime scanning configuration of a cluster.\nIt is returned by the get, enable, and disable runtime scanning endpoints.","type":"object","properties":{"type":{"description":" - NONE: NONE indicates runtime scanning is disabled; no agent is enforced.\n - WIZ: WIZ indicates runtime scanning is enforced using the Wiz agent.","type":"string","enum":["NONE","WIZ"],"isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"}},"example":{"type":"WIZ"},"required":["type"],"title":"RuntimeScanningInfo","uniqueKey":"","typeLabel":"RuntimeScanningInfo · object"},"examples":{"Example":{"title":"Example","value":{"type":"WIZ"}}},"exampleType":"generated"}},"exampleType":"generated"},"52983094-df9b-418b-a0f9-c92f3a2be926":{"description":"Returned when a request field is invalid.","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"3f678130-0942-4235-8dca-53e3be8e117a":{"description":"Returned when the token bearer cannot be authenticated.","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"e2557ea7-56bb-48a8-b7de-d46d0849ae99":{"description":"Returned when the user does not have permission to access the resource.","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"a5a041a4-e7d5-423d-8cc1-23d2fa2cf689":{"description":"Returned when the resource does not exist.","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"50ba26dd-7ee1-4fd1-a672-d563f22b779f":{"description":"Server error","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"af9830aa-6f0d-4152-a638-1b95c48fa94a":{"description":"An unexpected error response.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"format":"int32","type":"integer","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"details":{"type":"array","items":{"description":"`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nIn its binary encoding, an `Any` is an ordinary message; but in other wire\nforms like JSON, it has a special encoding. The format of the type URL is\ndescribed on the `type_url` field.\n\nProtobuf APIs provide utilities to interact with `Any` values:\n\n- A 'pack' operation accepts a message and constructs a generic `Any` wrapper\n around it.\n- An 'unpack' operation reads the content of an `Any` message, either into an\n existing message or a new one. Unpack operations must check the type of the\n value they unpack against the declared `type_url`.\n- An 'is' operation decides whether an `Any` contains a message of the given\n type, i.e. whether it can 'unpack' that type.\n\nThe JSON format representation of an `Any` follows one of these cases:\n\n- For types without special-cased JSON encodings, the JSON format\n representation of the `Any` is the same as that of the message, with an\n additional `@type` field which contains the type URL.\n- For types with special-cased JSON encodings (typically called 'well-known'\n types, listed in https://protobuf.dev/programming-guides/json/#any), the\n JSON format representation has a key `@type` which contains the type URL\n and a key `value` which contains the JSON-serialized value.\n\nThe text format representation of an `Any` is like a message with one field\nwhose name is the type URL in brackets. For example, an `Any` containing a\n`foo.Bar` message may be written `[type.googleapis.com/foo.Bar] { a: 2 }`.","type":"object","properties":{"@type":{"description":"Identifies the type of the serialized Protobuf message with a URI reference\nconsisting of a prefix ending in a slash and the fully-qualified type name.\n\nExample: type.googleapis.com/google.protobuf.StringValue\n\nThis string must contain at least one `/` character, and the content after\nthe last `/` must be the fully-qualified name of the type in canonical\nform, without a leading dot. Do not write a scheme on these URI references\nso that clients do not attempt to contact them.\n\nThe prefix is arbitrary and Protobuf implementations are expected to\nsimply strip off everything up to and including the last `/` to identify\nthe type. `type.googleapis.com/` is a common default prefix that some\nlegacy implementations require. This prefix does not indicate the origin of\nthe type, and URIs containing it are not expected to respond to any\nrequests.\n\nAll type URL strings must be legal URI references with the additional\nrestriction (for the text format) that the content of the reference\nmust consist only of alphanumeric characters, percent-encoded escapes, and\ncharacters in the following set (not including the outer backticks):\n`/-.~_!$\u0026()*+,;=`. Despite our allowing percent encodings, implementations\nshould not unescape them to prevent confusion with existing parsers. For\nexample, `type.googleapis.com%2FFoo` should be rejected.\n\nIn the original design of `Any`, the possibility of launching a type\nresolution service at these type URLs was considered but Protobuf never\nimplemented one and considers contacting these URLs to be problematic and\na potential security issue. Do not attempt to contact type URLs.","type":"string","uniqueKey":"details.items.[INDEX].@type","typeLabel":"string"}},"additionalProperties":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX].additionalProperties","typeLabel":"any"},"uniqueKey":"details.items.[INDEX]","typeLabel":"object"},"uniqueKey":"details","typeLabel":"object[]"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"details":[{"@type":"\u003cstring>"}],"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"bc452480-13bf-486e-9961-c443e714ceac":{"Bearer":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Bearer"}}},"servers":{"16c3f5cc-d364-4ff7-a7fe-b80ba8ccccd4":{"url":"https://cockroachlabs.cloud"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"Bearer"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"Bearer","name":"Authorization"}],"title":"Bearer"}]},"originalFileLocation":"openapi/cloud/latest.json"},"subdomain":"cockroachlabs","siteName":"CockroachDB","title":"Disable runtime scanning on a cluster. - CockroachDB","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-14T19:39:11.448Z","originalFileLocation":"docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster.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=\"Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER\">\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=\"Disable runtime scanning on a cluster. - CockroachDB\">\u003cmeta data-mint-head property=\"og:description\" content=\"Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CockroachDB\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cockroachlabs.mintlify.app/_mintlify/api/og/v2?division=Runtime+Scanning\u0026amp;title=Disable+runtime+scanning+on+a+cluster.\u0026amp;description=Can+be+used+by+the+following+roles+assigned+at+the+organization%2C+folder+or+cluster+scope%3A%0A-+CLUSTER_ADMIN%0A-+CLUSTER_OPERATOR_WRITER%0A\u0026amp;theme=7628870a42004e67b5b3df3d\u0026amp;signature=bc3e462b213b7ac7e468f0facbe958f8c8aae661eb18ab4b37fd46c1aa8fa697\">\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=\"Disable runtime scanning on a cluster. - CockroachDB\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cockroachlabs.mintlify.app/_mintlify/api/og/v2?division=Runtime+Scanning\u0026amp;title=Disable+runtime+scanning+on+a+cluster.\u0026amp;description=Can+be+used+by+the+following+roles+assigned+at+the+organization%2C+folder+or+cluster+scope%3A%0A-+CLUSTER_ADMIN%0A-+CLUSTER_OPERATOR_WRITER%0A\u0026amp;theme=7628870a42004e67b5b3df3d\u0026amp;signature=bc3e462b213b7ac7e468f0facbe958f8c8aae661eb18ab4b37fd46c1aa8fa697\">\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/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster.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/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster#webpage\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster\",\"name\":\"Disable runtime scanning on a cluster.\",\"description\":\"Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER\",\"dateModified\":\"2026-10-14T19:39:11.448Z\",\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/scim/list-groups\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Runtime Scanning\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/get-the-runtime-scanning-status-of-a-cluster\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Disable runtime scanning on a cluster.\",\"item\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster#apireference\",\"headline\":\"Disable runtime scanning on a cluster.\",\"name\":\"Disable runtime scanning on a cluster.\",\"description\":\"Can be used by the following roles assigned at the organization, folder or cluster scope: - CLUSTER_ADMIN - CLUSTER_OPERATOR_WRITER\",\"url\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cockroachlabs.com/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster#webpage\"},\"dateModified\":\"2026-10-14T19:39:11.448Z\",\"publisher\":{\"@id\":\"https://docs.cockroachlabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"}}]}\u003c/script>","siteName":"CockroachDB","nav":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"products":[{"product":"Cockroach Continuum Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cockroachlabs/images/continuum/cockroachlabs-symbol.svg","description":"The agentic database cloud","pages":[{"title":"Cockroach Continuum Cloud","href":"/docs/continuum"}]},{"product":"CockroachDB","icon":"database","description":"Distributed SQL database","pages":[{"title":"CockroachDB","href":"/docs/stable"}]},{"product":"Cloud Deployments","icon":"cloud","description":"Fully managed CockroachDB","tabs":[{"tab":"Deploy","icon":"rocket","pages":[{"title":"Deploy","href":"/docs/cockroachcloud"}]},{"tab":"Manage","icon":"sliders","pages":[{"title":"Manage","href":"/docs/cockroachcloud/overview-page"}]},{"tab":"Security","icon":"shield","pages":[{"title":"Security","href":"/docs/cockroachcloud/security-overview"}]},{"tab":"Cloud API Reference","icon":"book-open","dropdowns":[{"dropdown":"2026-09-15 (Latest)","icon":"books","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cloud API","href":"/docs/api/cloud"}]},{"group":"Endpoints","pages":[{"group":"SCIM","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Groups","href":"/docs/api/cloud/v1/scim/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Groups","href":"/docs/api/cloud/v1/scim/create-a-group"},{"title":"Search groups","deprecated":true,"version":null,"sidebarTitle":"Search groups","openapi":"/openapi/cloud/latest.json put /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/scim/search-groups-deprecated"},{"title":"Search groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/scim/search-groups"},{"title":"Get a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/scim/get-a-group-by-id"},{"title":"Update a group by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/scim/update-a-group-by-supplying-all-values-of-the-user-object"},{"title":"Delete a group based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/scim/delete-a-group-based-on-id"},{"title":"Patch a group by supplying partial updates","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/scim/patch-a-group-by-supplying-partial-updates"},{"title":"Search a group by ID","deprecated":true,"version":null,"sidebarTitle":"Search a group by ID","openapi":"/openapi/cloud/latest.json put /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/scim/search-a-group-by-id-deprecated"},{"title":"Search a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/scim/search-a-group-by-id"},{"title":"List the SCIM resource types","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/ResourceTypes","href":"/docs/api/cloud/v1/scim/list-the-scim-resource-types"},{"title":"Get a SCIM resource type by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/ResourceTypes/{resourceId}","href":"/docs/api/cloud/v1/scim/get-a-scim-resource-type-by-id"},{"title":"List the SCIM schemas","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Schemas","href":"/docs/api/cloud/v1/scim/list-the-scim-schemas"},{"title":"Get a SCIM schema by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Schemas/{schemaId}","href":"/docs/api/cloud/v1/scim/get-a-scim-schema-by-id"},{"title":"Return the SCIM Service Provider configuration","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/ServiceProviderConfig","href":"/docs/api/cloud/v1/scim/return-the-scim-service-provider-configuration"},{"title":"List Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Users","href":"/docs/api/cloud/v1/scim/list-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Users","href":"/docs/api/cloud/v1/scim/create-a-user"},{"title":"Search User","deprecated":true,"version":null,"sidebarTitle":"Search User","openapi":"/openapi/cloud/latest.json put /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/scim/search-user-deprecated"},{"title":"Search Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/scim/search-users"},{"title":"Get a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/scim/get-a-user-by-id"},{"title":"Update a user by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/scim/update-a-user-by-supplying-all-values-of-the-user-object"},{"title":"Delete a user based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/scim/delete-a-user-based-on-id"},{"title":"Patch a user by supplying partial updates","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/scim/patch-a-user-by-supplying-partial-updates"},{"title":"Search for a user by ID","deprecated":true,"version":null,"sidebarTitle":"Search for a user by ID","openapi":"/openapi/cloud/latest.json put /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/scim/search-for-a-user-by-id-deprecated"},{"title":"Search for a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/scim/search-for-a-user-by-id"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/api-keys","href":"/docs/api/cloud/v1/api-keys/list-api-keys"},{"title":"Create a new API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/api-keys","href":"/docs/api/cloud/v1/api-keys/create-a-new-api-key"},{"title":"Get an API Key by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/api-keys/get-an-api-key-by-id"},{"title":"Delete an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/api-keys/delete-an-api-key"},{"title":"Update an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/api-keys/update-an-api-key"}]},{"group":"Audit Logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/auditlogevents","href":"/docs/api/cloud/v1/audit-logs/list-audit-logs"}]},{"group":"Clusters","pages":[{"title":"List available major cluster versions","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/cluster-versions","href":"/docs/api/cloud/v1/clusters/list-available-major-cluster-versions"},{"title":"List clusters in the organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters","href":"/docs/api/cloud/v1/clusters/list-clusters-in-the-organization"},{"title":"Create and initialize a new cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters","href":"/docs/api/cloud/v1/clusters/create-and-initialize-a-new-cluster"},{"title":"List the regions available for new clusters and nodes","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/available-regions","href":"/docs/api/cloud/v1/clusters/list-the-regions-available-for-new-clusters-and-nodes"},{"title":"Get extended information about a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/clusters/get-extended-information-about-a-cluster"},{"title":"Delete a cluster and all of its data","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/clusters/delete-a-cluster-and-all-of-its-data"},{"title":"Scale, edit or upgrade a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/clusters/scale-edit-or-upgrade-a-cluster"},{"title":"Get a formatted generic connection string for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/connection-string","href":"/docs/api/cloud/v1/clusters/get-a-formatted-generic-connection-string-for-a-cluster"},{"title":"List nodes for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/nodes","href":"/docs/api/cloud/v1/clusters/list-nodes-for-a-cluster"}]},{"group":"Backup/Restore","pages":[{"title":"List cluster backups","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/backups","href":"/docs/api/cloud/v1/backuprestore/list-cluster-backups"},{"title":"Get the backup configuration for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/backups-config","href":"/docs/api/cloud/v1/backuprestore/get-the-backup-configuration-for-a-cluster"},{"title":"Update the backup configuration for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/backups-config","href":"/docs/api/cloud/v1/backuprestore/update-the-backup-configuration-for-a-cluster"},{"title":"List restore jobs","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/restores","href":"/docs/api/cloud/v1/backuprestore/list-restore-jobs"},{"title":"View a restore job","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/restores/{restore_id}","href":"/docs/api/cloud/v1/backuprestore/view-a-restore-job"},{"title":"Create a restore","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{destination_cluster_id}/restores","href":"/docs/api/cloud/v1/backuprestore/create-a-restore"}]},{"group":"Blackout Windows","pages":[{"title":"List all blackout windows for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/blackout-windows","href":"/docs/api/cloud/v1/blackout-windows/list-all-blackout-windows-for-a-cluster"},{"title":"Create a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/blackout-windows","href":"/docs/api/cloud/v1/blackout-windows/create-a-blackout-window-for-a-cluster"},{"title":"Get a blackout window by its ID for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/blackout-windows/get-a-blackout-window-by-its-id-for-a-cluster"},{"title":"Delete a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/blackout-windows/delete-a-blackout-window-for-a-cluster"},{"title":"Update a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/blackout-windows/update-a-blackout-window-for-a-cluster"}]},{"group":"Client CA Certificates","pages":[{"title":"Get Client CA Cert information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/client-ca-certificates/get-client-ca-cert-information-for-a-cluster"},{"title":"Set Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/client-ca-certificates/set-client-ca-cert-for-a-cluster"},{"title":"Delete Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/client-ca-certificates/delete-client-ca-cert-for-a-cluster"},{"title":"Update Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/client-ca-certificates/update-client-ca-cert-for-a-cluster"}]},{"group":"Customer-managed Encryption Keys","pages":[{"title":"Get CMEK-related information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/customer-managed-encryption-keys/get-cmek-related-information-for-a-cluster"},{"title":"Enable or update the CMEK spec for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/customer-managed-encryption-keys/enable-or-update-the-cmek-spec-for-a-cluster"},{"title":"Enable CMEK for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/customer-managed-encryption-keys/enable-cmek-for-a-cluster"},{"title":"Update the CMEK-related status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/customer-managed-encryption-keys/update-the-cmek-related-status-for-a-cluster"}]},{"group":"Databases","pages":[{"title":"List databases for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/databases/list-databases-for-a-cluster"},{"title":"Create a new database","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/databases/create-a-new-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/databases/update-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/databases/delete-a-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/databases/update-a-database-1"}]},{"group":"Cluster Disruption","pages":[{"title":"Get disruption specifications for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/disrupt","href":"/docs/api/cloud/v1/cluster-disruption/get-disruption-specifications-for-a-cluster"},{"title":"Update disruption specifications for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/disrupt","href":"/docs/api/cloud/v1/cluster-disruption/update-disruption-specifications-for-a-cluster"}]},{"group":"Log Export","pages":[{"title":"Get the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/log-export/get-the-log-export-configuration-for-a-cluster"},{"title":"Create or update the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/log-export/create-or-update-the-log-export-configuration-for-a-cluster"},{"title":"Delete the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/log-export/delete-the-log-export-configuration-for-a-cluster"}]},{"group":"Maintenance Windows","pages":[{"title":"Get the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/maintenance-windows/get-the-maintenance-window-for-a-cluster"},{"title":"Set the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/maintenance-windows/set-the-maintenance-window-for-a-cluster"},{"title":"Delete the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/maintenance-windows/delete-the-maintenance-window-for-a-cluster"}]},{"group":"Metric Export","pages":[{"title":"Get the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/metric-export/get-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Create or update the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/metric-export/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Delete the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/metric-export/delete-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Get the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/metric-export/get-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Create or update the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/metric-export/create-or-update-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Delete the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/metric-export/delete-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Get the Prometheus Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/metric-export/get-the-prometheus-metric-export-configuration-for-a-cluster"},{"title":"Enable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/metric-export/enable-prometheus-metric-export-for-a-cluster"},{"title":"Disable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/metric-export/disable-prometheus-metric-export-for-a-cluster"}]},{"group":"Migration Assistant","pages":[{"title":"Get the Migration Assistant for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/migration-assistant","href":"/docs/api/cloud/v1/migration-assistant/get-the-migration-assistant-for-a-cluster"},{"title":"Provision a Migration Assistant for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/migration-assistant","href":"/docs/api/cloud/v1/migration-assistant/provision-a-migration-assistant-for-a-cluster"},{"title":"Delete the Migration Assistant for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/migration-assistant","href":"/docs/api/cloud/v1/migration-assistant/delete-the-migration-assistant-for-a-cluster"},{"title":"Get the source-database CA certificate for a cluster's Migration Assistant.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/migration-assistant/source-ca-cert","href":"/docs/api/cloud/v1/migration-assistant/get-the-source-database-ca-certificate-for-a-clusters-migration-assistant"},{"title":"Delete the source-database CA certificate for a cluster's Migration Assistant.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/migration-assistant/source-ca-cert","href":"/docs/api/cloud/v1/migration-assistant/delete-the-source-database-ca-certificate-for-a-clusters-migration-assistant"},{"title":"Update the source-database CA certificate for a cluster's Migration Assistant.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/migration-assistant/source-ca-cert","href":"/docs/api/cloud/v1/migration-assistant/update-the-source-database-ca-certificate-for-a-clusters-migration-assistant"}]},{"group":"IP Allowlists","pages":[{"title":"Get the IP allowlist and propagation status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/ip-allowlists/get-the-ip-allowlist-and-propagation-status-for-a-cluster"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist-1"},{"title":"Delete an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/ip-allowlists/delete-an-ip-allowlist-entry"},{"title":"Update an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/ip-allowlists/update-an-ip-allowlist-entry"}]},{"group":"Private Endpoint Services","pages":[{"title":"List all AwsEndpointConnections for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections","href":"/docs/api/cloud/v1/private-endpoint-services/list-all-awsendpointconnections-for-a-cluster"},{"title":"Set the AWS Endpoint Connection state","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/private-endpoint-services/set-the-aws-endpoint-connection-state"},{"title":"List all connections to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/private-endpoint-services/list-all-connections-to-a-clusters-private-endpoint-service"},{"title":"Add a connection to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/private-endpoint-services/add-a-connection-to-a-clusters-private-endpoint-service"},{"title":"Delete a connection from a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/private-endpoint-services/delete-a-connection-from-a-clusters-private-endpoint-service"},{"title":"List all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/private-endpoint-services/list-all-privateendpointservices-for-a-cluster"},{"title":"Create all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/private-endpoint-services/create-all-privateendpointservices-for-a-cluster"},{"title":"List all private endpoint trusted owners for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/private-endpoint-services/list-all-private-endpoint-trusted-owners-for-a-cluster"},{"title":"Add a private endpoint trusted owner to a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/private-endpoint-services/add-a-private-endpoint-trusted-owner-to-a-cluster"},{"title":"Get a private endpoint trusted owner entry for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/private-endpoint-services/get-a-private-endpoint-trusted-owner-entry-for-a-cluster"},{"title":"Remove a private endpoint trusted owner from a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/private-endpoint-services/remove-a-private-endpoint-trusted-owner-from-a-cluster"}]},{"group":"Egress Private Endpoints","pages":[{"title":"List egress private endpoints","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints","href":"/docs/api/cloud/v1/egress-private-endpoints/list-egress-private-endpoints"},{"title":"Create an egress private endpoint","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints","href":"/docs/api/cloud/v1/egress-private-endpoints/create-an-egress-private-endpoint"},{"title":"Get egress private endpoint","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/egress-private-endpoints/get-egress-private-endpoint"},{"title":"Delete an egress private endpoint","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/egress-private-endpoints/delete-an-egress-private-endpoint"},{"title":"Update egress private endpoint.","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/egress-private-endpoints/update-egress-private-endpoint"},{"title":"Update egress private endpoint domain names","deprecated":true,"version":null,"tag":"Limited Access","sidebarTitle":"Update egress private endpoint domain names","openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}/domain-names","href":"/docs/api/cloud/v1/egress-private-endpoints/update-egress-private-endpoint-domain-names-this-endpoint-is-deprecatedin-favor-of-patch-apiv1clusters-networkingegress-private-endpoints-and-will-be-removed-in-a-future-version"}]},{"group":"Egress Rules","pages":[{"title":"List all egress rules associated with a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/egress-rules/list-all-egress-rules-associated-with-a-cluster"},{"title":"Add an egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/egress-rules/add-an-egress-rule"},{"title":"Outbound traffic management","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/networking/egress-rules/egress-traffic-policy","href":"/docs/api/cloud/v1/egress-rules/outbound-traffic-management"},{"title":"Get an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/egress-rules/get-an-existing-egress-rule"},{"title":"Delete an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/egress-rules/delete-an-existing-egress-rule"},{"title":"Edit an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/egress-rules/edit-an-existing-egress-rule"}]},{"group":"Runtime Scanning","pages":[{"title":"Get the runtime scanning status of a cluster.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/runtime-scanning/get-the-runtime-scanning-status-of-a-cluster"},{"title":"Enable runtime scanning on a cluster.","description":"Can be used by the following roles assigned at the organization, folder or cluster scope:\n- CLUSTER_ADMIN\n- CLUSTER_OPERATOR_WRITER\n","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/runtime-scanning/enable-runtime-scanning-on-a-cluster"},{"title":"Disable runtime scanning on a cluster.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/runtime-scanning/disable-runtime-scanning-on-a-cluster"}]},{"group":"SQL Users","pages":[{"title":"List SQL users for a cluster","description":"Sort order: Username\n\nCan be used by the following roles assigned at the organization, folder or cluster scope:\n- CLUSTER_ADMIN\n- CLUSTER_OPERATOR_WRITER\n- CLUSTER_DEVELOPER\n","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/sql-users/list-sql-users-for-a-cluster"},{"title":"Create a new SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/sql-users/create-a-new-sql-user"},{"title":"Delete a SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/clusters/{cluster_id}/sql-users/{name}","href":"/docs/api/cloud/v1/sql-users/delete-a-sql-user"},{"title":"Update a SQL user's password","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/sql-users/{name}/password","href":"/docs/api/cloud/v1/sql-users/update-a-sql-users-password"}]},{"group":"Version Deferral","pages":[{"title":"Get the version upgrade deferral policy for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/version-deferral/get-the-version-upgrade-deferral-policy-for-a-cluster"},{"title":"Set the version upgrade deferral policy for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json put /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/version-deferral/set-the-version-upgrade-deferral-policy-for-a-cluster"}]},{"group":"Folders","pages":[{"title":"List folders owned by an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/folders","href":"/docs/api/cloud/v1/folders/list-folders-owned-by-an-organization"},{"title":"Create a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/folders","href":"/docs/api/cloud/v1/folders/create-a-folder"},{"title":"Get folder info for a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/folders/get-folder-info-for-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/folders/delete-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/folders/update-a-folder"},{"title":"List contents of a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/folders/{folder_id}/contents","href":"/docs/api/cloud/v1/folders/list-contents-of-a-folder"}]},{"group":"Billing","pages":[{"title":"List invoices for a given organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/invoices","href":"/docs/api/cloud/v1/billing/list-invoices-for-a-given-organization"},{"title":"Get a specific invoice for an organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/invoices/{invoice_id}","href":"/docs/api/cloud/v1/billing/get-a-specific-invoice-for-an-organization"},{"title":"List an invoice's daily usage breakdown","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/invoices/{invoice_id}/daily-usage","href":"/docs/api/cloud/v1/billing/list-an-invoices-daily-usage-breakdown"}]},{"group":"JWT Issuers","pages":[{"title":"List all JWT Issuers","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/jwt-issuers/list-all-jwt-issuers"},{"title":"Add a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json post /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/jwt-issuers/add-a-jwt-issuer"},{"title":"Get a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/jwt-issuers/get-a-jwt-issuer"},{"title":"Delete a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/jwt-issuers/delete-a-jwt-issuer"},{"title":"Update a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json patch /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/jwt-issuers/update-a-jwt-issuer"}]},{"group":"Organizations","pages":[{"title":"Get information about the caller's organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/organization","href":"/docs/api/cloud/v1/organizations/get-information-about-the-callers-organization"}]},{"group":"Physical Cluster Replication","pages":[{"title":"List physical replication streams","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/physical-replication-streams","href":"/docs/api/cloud/v1/physical-cluster-replication/list-physical-replication-streams"},{"title":"Create a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/physical-replication-streams","href":"/docs/api/cloud/v1/physical-cluster-replication/create-a-physical-replication-stream"},{"title":"Get a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/physical-replication-streams/{id}","href":"/docs/api/cloud/v1/physical-cluster-replication/get-a-physical-replication-stream"},{"title":"Update a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/physical-replication-streams/{id}","href":"/docs/api/cloud/v1/physical-cluster-replication/update-a-physical-replication-stream"}]},{"group":"Role Management","pages":[{"title":"List all RoleGrants","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/roles","href":"/docs/api/cloud/v1/role-management/list-all-rolegrants"},{"title":"Get all role grants for a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/role-management/get-all-role-grants-for-a-user-service-account-or-group"},{"title":"Replace the roles for a user, service account, or group with exactly those provided","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json put /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/role-management/replace-the-roles-for-a-user-service-account-or-group-with-exactly-those-provided"},{"title":"Add a role to a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json post /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/role-management/add-a-role-to-a-user-service-account-or-group"},{"title":"Remove a role from a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json delete /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/role-management/remove-a-role-from-a-user-service-account-or-group"},{"title":"Search person users by email address","deprecated":null,"version":null,"openapi":"/openapi/cloud/latest.json get /api/v1/users/persons-by-email","href":"/docs/api/cloud/v1/role-management/search-person-users-by-email-address"}]},{"group":"Service Accounts","pages":[{"title":"List service accounts for an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/service-accounts","href":"/docs/api/cloud/v1/service-accounts/list-service-accounts-for-an-organization"},{"title":"Create a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json post /api/v1/service-accounts","href":"/docs/api/cloud/v1/service-accounts/create-a-service-account"},{"title":"Get a service account by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json get /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/service-accounts/get-a-service-account-by-id"},{"title":"Delete a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json delete /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/service-accounts/update-a-service-account"},{"title":"List a service account's OAuth credentials","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json get /api/v1/service-accounts/{service_account_id}/credentials","href":"/docs/api/cloud/v1/service-accounts/list-a-service-accounts-oauth-credentials"},{"title":"Create an OAuth credential for a service account","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json post /api/v1/service-accounts/{service_account_id}/credentials","href":"/docs/api/cloud/v1/service-accounts/create-an-oauth-credential-for-a-service-account"},{"title":"Delete a service account's OAuth credential","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/latest.json delete /api/v1/service-accounts/{service_account_id}/credentials/{credential_id}","href":"/docs/api/cloud/v1/service-accounts/delete-a-service-accounts-oauth-credential"}]},{"group":"Virtual Cluster Workspaces","pages":[{"title":"List workspaces in the organization","deprecated":null,"version":null,"tag":"Continuum · Preview","openapi":"/openapi/cloud/latest.json get /api/v1/virtual-cluster-workspaces","href":"/docs/api/cloud/v1/virtual-cluster-workspaces/list-workspaces-in-the-organization"},{"title":"Show details for a specific workspace","deprecated":null,"version":null,"tag":"Continuum · Preview","openapi":"/openapi/cloud/latest.json get /api/v1/virtual-cluster-workspaces/{workspace_id}","href":"/docs/api/cloud/v1/virtual-cluster-workspaces/show-details-for-a-specific-workspace"},{"title":"Update the configuration of a specific workspace","deprecated":null,"version":null,"tag":"Continuum · Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/virtual-cluster-workspaces/{workspace_id}","href":"/docs/api/cloud/v1/virtual-cluster-workspaces/update-the-configuration-of-a-specific-workspace"},{"title":"Create a virtual cluster in a workspace","deprecated":null,"version":null,"tag":"Continuum · Preview","openapi":"/openapi/cloud/latest.json post /api/v1/virtual-cluster-workspaces/{workspace_id}/clusters","href":"/docs/api/cloud/v1/virtual-cluster-workspaces/create-a-virtual-cluster-in-a-workspace"},{"title":"Update a specific virtual cluster","deprecated":null,"version":null,"tag":"Continuum · Preview","openapi":"/openapi/cloud/latest.json patch /api/v1/virtual-cluster-workspaces/{workspace_id}/clusters/{cluster_id}","href":"/docs/api/cloud/v1/virtual-cluster-workspaces/update-a-specific-virtual-cluster"}]}]}]},{"dropdown":"2024-09-16","icon":"books","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cloud API","href":"/docs/api/cloud/2024-09-16"}]},{"group":"Endpoints","pages":[{"group":"SCIM","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Groups","href":"/docs/api/cloud/v1/2024-09-16/scim/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Groups","href":"/docs/api/cloud/v1/2024-09-16/scim/create-a-group"},{"title":"Search groups","deprecated":true,"version":null,"sidebarTitle":"Search groups","openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-groups-deprecated"},{"title":"Search groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-groups"},{"title":"Get a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/get-a-group-by-id"},{"title":"Update a group by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/update-a-group-by-supplying-all-values-of-the-user-object"},{"title":"Delete a group based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/delete-a-group-based-on-id"},{"title":"Patch a group by supplying partial updates","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/patch-a-group-by-supplying-partial-updates"},{"title":"Search a group by ID","deprecated":true,"version":null,"sidebarTitle":"Search a group by ID","openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-a-group-by-id-deprecated"},{"title":"Search a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-a-group-by-id"},{"title":"List the SCIM resource types","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/ResourceTypes","href":"/docs/api/cloud/v1/2024-09-16/scim/list-the-scim-resource-types"},{"title":"Get a SCIM resource type by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/ResourceTypes/{resourceId}","href":"/docs/api/cloud/v1/2024-09-16/scim/get-a-scim-resource-type-by-id"},{"title":"List the SCIM schemas","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Schemas","href":"/docs/api/cloud/v1/2024-09-16/scim/list-the-scim-schemas"},{"title":"Get a SCIM schema by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Schemas/{schemaId}","href":"/docs/api/cloud/v1/2024-09-16/scim/get-a-scim-schema-by-id"},{"title":"Return the SCIM Service Provider configuration","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/ServiceProviderConfig","href":"/docs/api/cloud/v1/2024-09-16/scim/return-the-scim-service-provider-configuration"},{"title":"List Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Users","href":"/docs/api/cloud/v1/2024-09-16/scim/list-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Users","href":"/docs/api/cloud/v1/2024-09-16/scim/create-a-user"},{"title":"Search User","deprecated":true,"version":null,"sidebarTitle":"Search User","openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-user-deprecated"},{"title":"Search Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-users"},{"title":"Get a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/get-a-user-by-id"},{"title":"Update a user by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/update-a-user-by-supplying-all-values-of-the-user-object"},{"title":"Delete a user based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/delete-a-user-based-on-id"},{"title":"Patch a user by supplying partial updates","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2024-09-16/scim/patch-a-user-by-supplying-partial-updates"},{"title":"Search for a user by ID","deprecated":true,"version":null,"sidebarTitle":"Search for a user by ID","openapi":"/openapi/cloud/2024-09-16.json put /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-for-a-user-by-id-deprecated"},{"title":"Search for a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/2024-09-16/scim/search-for-a-user-by-id"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/api-keys","href":"/docs/api/cloud/v1/2024-09-16/api-keys/list-api-keys"},{"title":"Create a new API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/api-keys","href":"/docs/api/cloud/v1/2024-09-16/api-keys/create-a-new-api-key"},{"title":"Get an API Key by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2024-09-16/api-keys/get-an-api-key-by-id"},{"title":"Delete an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2024-09-16/api-keys/delete-an-api-key"},{"title":"Update an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2024-09-16/api-keys/update-an-api-key"}]},{"group":"Audit Logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/auditlogevents","href":"/docs/api/cloud/v1/2024-09-16/audit-logs/list-audit-logs"}]},{"group":"Clusters","pages":[{"title":"List available major cluster versions","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/cluster-versions","href":"/docs/api/cloud/v1/2024-09-16/clusters/list-available-major-cluster-versions"},{"title":"List clusters in the organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters","href":"/docs/api/cloud/v1/2024-09-16/clusters/list-clusters-in-the-organization"},{"title":"Create and initialize a new cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters","href":"/docs/api/cloud/v1/2024-09-16/clusters/create-and-initialize-a-new-cluster"},{"title":"List the regions available for new clusters and nodes","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/available-regions","href":"/docs/api/cloud/v1/2024-09-16/clusters/list-the-regions-available-for-new-clusters-and-nodes"},{"title":"Get extended information about a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2024-09-16/clusters/get-extended-information-about-a-cluster"},{"title":"Delete a cluster and all of its data","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2024-09-16/clusters/delete-a-cluster-and-all-of-its-data"},{"title":"Scale, edit or upgrade a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2024-09-16/clusters/scale-edit-or-upgrade-a-cluster"},{"title":"Get a formatted generic connection string for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/connection-string","href":"/docs/api/cloud/v1/2024-09-16/clusters/get-a-formatted-generic-connection-string-for-a-cluster"},{"title":"List nodes for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/nodes","href":"/docs/api/cloud/v1/2024-09-16/clusters/list-nodes-for-a-cluster"}]},{"group":"Backup/Restore","pages":[{"title":"List cluster backups","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/backups","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/list-cluster-backups"},{"title":"Get the backup configuration for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/backups-config","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/get-the-backup-configuration-for-a-cluster"},{"title":"Update the backup configuration for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/backups-config","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/update-the-backup-configuration-for-a-cluster"},{"title":"List restore jobs","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/restores","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/list-restore-jobs"},{"title":"View a restore job","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/restores/{restore_id}","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/view-a-restore-job"},{"title":"Create a restore","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{destination_cluster_id}/restores","href":"/docs/api/cloud/v1/2024-09-16/backuprestore/create-a-restore"}]},{"group":"Blackout Windows","pages":[{"title":"List all blackout windows for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/blackout-windows","href":"/docs/api/cloud/v1/2024-09-16/blackout-windows/list-all-blackout-windows-for-a-cluster"},{"title":"Create a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/blackout-windows","href":"/docs/api/cloud/v1/2024-09-16/blackout-windows/create-a-blackout-window-for-a-cluster"},{"title":"Get a blackout window by its ID for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/2024-09-16/blackout-windows/get-a-blackout-window-by-its-id-for-a-cluster"},{"title":"Delete a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/2024-09-16/blackout-windows/delete-a-blackout-window-for-a-cluster"},{"title":"Update a blackout window for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/blackout-windows/{blackout_window_id}","href":"/docs/api/cloud/v1/2024-09-16/blackout-windows/update-a-blackout-window-for-a-cluster"}]},{"group":"Client CA Certificates","pages":[{"title":"Get Client CA Cert information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2024-09-16/client-ca-certificates/get-client-ca-cert-information-for-a-cluster"},{"title":"Set Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2024-09-16/client-ca-certificates/set-client-ca-cert-for-a-cluster"},{"title":"Delete Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2024-09-16/client-ca-certificates/delete-client-ca-cert-for-a-cluster"},{"title":"Update Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2024-09-16/client-ca-certificates/update-client-ca-cert-for-a-cluster"}]},{"group":"Customer-managed Encryption Keys","pages":[{"title":"Get CMEK-related information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2024-09-16/customer-managed-encryption-keys/get-cmek-related-information-for-a-cluster"},{"title":"Enable or update the CMEK spec for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2024-09-16/customer-managed-encryption-keys/enable-or-update-the-cmek-spec-for-a-cluster"},{"title":"Enable CMEK for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2024-09-16/customer-managed-encryption-keys/enable-cmek-for-a-cluster"},{"title":"Update the CMEK-related status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2024-09-16/customer-managed-encryption-keys/update-the-cmek-related-status-for-a-cluster"}]},{"group":"Databases","pages":[{"title":"List databases for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2024-09-16/databases/list-databases-for-a-cluster"},{"title":"Create a new database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2024-09-16/databases/create-a-new-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2024-09-16/databases/update-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2024-09-16/databases/delete-a-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2024-09-16/databases/update-a-database-1"}]},{"group":"Cluster Disruption","pages":[{"title":"Get disruption specifications for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/disrupt","href":"/docs/api/cloud/v1/2024-09-16/cluster-disruption/get-disruption-specifications-for-a-cluster"},{"title":"Update disruption specifications for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/disrupt","href":"/docs/api/cloud/v1/2024-09-16/cluster-disruption/update-disruption-specifications-for-a-cluster"}]},{"group":"Log Export","pages":[{"title":"Get the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2024-09-16/log-export/get-the-log-export-configuration-for-a-cluster"},{"title":"Create or update the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2024-09-16/log-export/create-or-update-the-log-export-configuration-for-a-cluster"},{"title":"Delete the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2024-09-16/log-export/delete-the-log-export-configuration-for-a-cluster"}]},{"group":"Maintenance Windows","pages":[{"title":"Get the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2024-09-16/maintenance-windows/get-the-maintenance-window-for-a-cluster"},{"title":"Set the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2024-09-16/maintenance-windows/set-the-maintenance-window-for-a-cluster"},{"title":"Delete the maintenance window for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2024-09-16/maintenance-windows/delete-the-maintenance-window-for-a-cluster"}]},{"group":"Metric Export","pages":[{"title":"Get the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2024-09-16/metric-export/get-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Create or update the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2024-09-16/metric-export/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Delete the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2024-09-16/metric-export/delete-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Get the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2024-09-16/metric-export/get-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Create or update the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2024-09-16/metric-export/create-or-update-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Delete the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2024-09-16/metric-export/delete-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Get the Prometheus Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2024-09-16/metric-export/get-the-prometheus-metric-export-configuration-for-a-cluster"},{"title":"Enable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2024-09-16/metric-export/enable-prometheus-metric-export-for-a-cluster"},{"title":"Disable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2024-09-16/metric-export/disable-prometheus-metric-export-for-a-cluster"}]},{"group":"IP Allowlists","pages":[{"title":"Get the IP allowlist and propagation status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2024-09-16/ip-allowlists/get-the-ip-allowlist-and-propagation-status-for-a-cluster"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2024-09-16/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2024-09-16/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist-1"},{"title":"Delete an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2024-09-16/ip-allowlists/delete-an-ip-allowlist-entry"},{"title":"Update an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2024-09-16/ip-allowlists/update-an-ip-allowlist-entry"}]},{"group":"Private Endpoint Services","pages":[{"title":"List all AwsEndpointConnections for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/list-all-awsendpointconnections-for-a-cluster"},{"title":"Set the AWS Endpoint Connection state","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/set-the-aws-endpoint-connection-state"},{"title":"List all connections to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/list-all-connections-to-a-clusters-private-endpoint-service"},{"title":"Add a connection to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/add-a-connection-to-a-clusters-private-endpoint-service"},{"title":"Delete a connection from a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/delete-a-connection-from-a-clusters-private-endpoint-service"},{"title":"List all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/list-all-privateendpointservices-for-a-cluster"},{"title":"Create all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/create-all-privateendpointservices-for-a-cluster"},{"title":"List all private endpoint trusted owners for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/list-all-private-endpoint-trusted-owners-for-a-cluster"},{"title":"Add a private endpoint trusted owner to a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/add-a-private-endpoint-trusted-owner-to-a-cluster"},{"title":"Get a private endpoint trusted owner entry for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/get-a-private-endpoint-trusted-owner-entry-for-a-cluster"},{"title":"Remove a private endpoint trusted owner from a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/2024-09-16/private-endpoint-services/remove-a-private-endpoint-trusted-owner-from-a-cluster"}]},{"group":"Egress Private Endpoints","pages":[{"title":"List egress private endpoints","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/list-egress-private-endpoints"},{"title":"Create an egress private endpoint","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/create-an-egress-private-endpoint"},{"title":"Get egress private endpoint","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/get-egress-private-endpoint"},{"title":"Delete an egress private endpoint","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/delete-an-egress-private-endpoint"},{"title":"Update egress private endpoint.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/update-egress-private-endpoint"},{"title":"Update egress private endpoint domain names","deprecated":true,"version":null,"tag":"Limited Access","sidebarTitle":"Update egress private endpoint domain names","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/networking/egress-private-endpoints/{id}/domain-names","href":"/docs/api/cloud/v1/2024-09-16/egress-private-endpoints/update-egress-private-endpoint-domain-names-this-endpoint-is-deprecatedin-favor-of-patch-apiv1clusters-networkingegress-private-endpoints-and-will-be-removed-in-a-future-version"}]},{"group":"Egress Rules","pages":[{"title":"List all egress rules associated with a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/list-all-egress-rules-associated-with-a-cluster"},{"title":"Add an egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/add-an-egress-rule"},{"title":"Outbound traffic management","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/networking/egress-rules/egress-traffic-policy","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/outbound-traffic-management"},{"title":"Get an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/get-an-existing-egress-rule"},{"title":"Delete an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/delete-an-existing-egress-rule"},{"title":"Edit an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2024-09-16/egress-rules/edit-an-existing-egress-rule"}]},{"group":"Runtime Scanning","pages":[{"title":"Get the runtime scanning status of a cluster.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/2024-09-16/runtime-scanning/get-the-runtime-scanning-status-of-a-cluster"},{"title":"Enable runtime scanning on a cluster.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/2024-09-16/runtime-scanning/enable-runtime-scanning-on-a-cluster"},{"title":"Disable runtime scanning on a cluster.","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/runtime-scanning","href":"/docs/api/cloud/v1/2024-09-16/runtime-scanning/disable-runtime-scanning-on-a-cluster"}]},{"group":"SQL Users","pages":[{"title":"List SQL users for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2024-09-16/sql-users/list-sql-users-for-a-cluster"},{"title":"Create a new SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2024-09-16/sql-users/create-a-new-sql-user"},{"title":"Delete a SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/clusters/{cluster_id}/sql-users/{name}","href":"/docs/api/cloud/v1/2024-09-16/sql-users/delete-a-sql-user"},{"title":"Update a SQL user's password","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/sql-users/{name}/password","href":"/docs/api/cloud/v1/2024-09-16/sql-users/update-a-sql-users-password"}]},{"group":"Version Deferral","pages":[{"title":"Get the version upgrade deferral policy for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/2024-09-16/version-deferral/get-the-version-upgrade-deferral-policy-for-a-cluster"},{"title":"Set the version upgrade deferral policy for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json put /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/2024-09-16/version-deferral/set-the-version-upgrade-deferral-policy-for-a-cluster"}]},{"group":"Folders","pages":[{"title":"List folders owned by an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/folders","href":"/docs/api/cloud/v1/2024-09-16/folders/list-folders-owned-by-an-organization"},{"title":"Create a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/folders","href":"/docs/api/cloud/v1/2024-09-16/folders/create-a-folder"},{"title":"Get folder info for a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2024-09-16/folders/get-folder-info-for-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2024-09-16/folders/delete-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2024-09-16/folders/update-a-folder"},{"title":"List contents of a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/folders/{folder_id}/contents","href":"/docs/api/cloud/v1/2024-09-16/folders/list-contents-of-a-folder"}]},{"group":"Billing","pages":[{"title":"List invoices for a given organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/invoices","href":"/docs/api/cloud/v1/2024-09-16/billing/list-invoices-for-a-given-organization"},{"title":"Get a specific invoice for an organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/invoices/{invoice_id}","href":"/docs/api/cloud/v1/2024-09-16/billing/get-a-specific-invoice-for-an-organization"}]},{"group":"JWT Issuers","pages":[{"title":"List all JWT Issuers","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/2024-09-16/jwt-issuers/list-all-jwt-issuers"},{"title":"Add a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/2024-09-16/jwt-issuers/add-a-jwt-issuer"},{"title":"Get a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2024-09-16/jwt-issuers/get-a-jwt-issuer"},{"title":"Delete a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2024-09-16/jwt-issuers/delete-a-jwt-issuer"},{"title":"Update a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2024-09-16/jwt-issuers/update-a-jwt-issuer"}]},{"group":"Organizations","pages":[{"title":"Get information about the caller's organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/organization","href":"/docs/api/cloud/v1/2024-09-16/organizations/get-information-about-the-callers-organization"}]},{"group":"Physical Cluster Replication","pages":[{"title":"List physical replication streams","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/physical-replication-streams","href":"/docs/api/cloud/v1/2024-09-16/physical-cluster-replication/list-physical-replication-streams"},{"title":"Create a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/physical-replication-streams","href":"/docs/api/cloud/v1/2024-09-16/physical-cluster-replication/create-a-physical-replication-stream"},{"title":"Get a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/physical-replication-streams/{id}","href":"/docs/api/cloud/v1/2024-09-16/physical-cluster-replication/get-a-physical-replication-stream"},{"title":"Update a physical replication stream","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/physical-replication-streams/{id}","href":"/docs/api/cloud/v1/2024-09-16/physical-cluster-replication/update-a-physical-replication-stream"}]},{"group":"Role Management","pages":[{"title":"List all RoleGrants","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/roles","href":"/docs/api/cloud/v1/2024-09-16/role-management/list-all-rolegrants"},{"title":"Get all role grants for a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2024-09-16/role-management/get-all-role-grants-for-a-user-service-account-or-group"},{"title":"Replace the roles for a user, service account, or group with exactly those provided","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json put /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2024-09-16/role-management/replace-the-roles-for-a-user-service-account-or-group-with-exactly-those-provided"},{"title":"Add a role to a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json post /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2024-09-16/role-management/add-a-role-to-a-user-service-account-or-group"},{"title":"Remove a role from a user, service account, or group","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2024-09-16/role-management/remove-a-role-from-a-user-service-account-or-group"},{"title":"Search person users by email address","deprecated":null,"version":null,"openapi":"/openapi/cloud/2024-09-16.json get /api/v1/users/persons-by-email","href":"/docs/api/cloud/v1/2024-09-16/role-management/search-person-users-by-email-address"}]},{"group":"Service Accounts","pages":[{"title":"List service accounts for an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/service-accounts","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/list-service-accounts-for-an-organization"},{"title":"Create a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/service-accounts","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/create-a-service-account"},{"title":"Get a service account by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/get-a-service-account-by-id"},{"title":"Delete a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2024-09-16.json patch /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/update-a-service-account"},{"title":"List a service account's OAuth credentials","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json get /api/v1/service-accounts/{service_account_id}/credentials","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/list-a-service-accounts-oauth-credentials"},{"title":"Create an OAuth credential for a service account","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json post /api/v1/service-accounts/{service_account_id}/credentials","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/create-an-oauth-credential-for-a-service-account"},{"title":"Delete a service account's OAuth credential","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2024-09-16.json delete /api/v1/service-accounts/{service_account_id}/credentials/{credential_id}","href":"/docs/api/cloud/v1/2024-09-16/service-accounts/delete-a-service-accounts-oauth-credential"}]}]}]},{"dropdown":"2023-04-10","icon":"books","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cloud API","href":"/docs/api/cloud/2023-04-10"}]},{"group":"Endpoints","pages":[{"group":"SCIM","pages":[{"title":"List groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Groups","href":"/docs/api/cloud/v1/2023-04-10/scim/list-groups"},{"title":"Create a group","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Groups","href":"/docs/api/cloud/v1/2023-04-10/scim/create-a-group"},{"title":"Search groups","deprecated":true,"version":null,"sidebarTitle":"Search groups","openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-groups"},{"title":"Search groups","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Groups/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-groups-1"},{"title":"Get a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/get-a-group-by-id"},{"title":"Update a group by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/update-a-group-by-supplying-all-values-of-the-user-object"},{"title":"Delete a group based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/scim/v2/Groups/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/delete-a-group-based-on-id"},{"title":"Search a group by ID","deprecated":true,"version":null,"sidebarTitle":"Search a group by ID","openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-a-group-by-id"},{"title":"Search a group by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Groups/{id}/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-a-group-by-id-1"},{"title":"List the SCIM resource types","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/ResourceTypes","href":"/docs/api/cloud/v1/2023-04-10/scim/list-the-scim-resource-types"},{"title":"Get a SCIM resource type by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/ResourceTypes/{resourceId}","href":"/docs/api/cloud/v1/2023-04-10/scim/get-a-scim-resource-type-by-id"},{"title":"List the SCIM schemas","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Schemas","href":"/docs/api/cloud/v1/2023-04-10/scim/list-the-scim-schemas"},{"title":"Get a SCIM schema by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Schemas/{schemaId}","href":"/docs/api/cloud/v1/2023-04-10/scim/get-a-scim-schema-by-id"},{"title":"Return the SCIM Service Provider configuration","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/ServiceProviderConfig","href":"/docs/api/cloud/v1/2023-04-10/scim/return-the-scim-service-provider-configuration"},{"title":"List Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Users","href":"/docs/api/cloud/v1/2023-04-10/scim/list-users"},{"title":"Create a user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Users","href":"/docs/api/cloud/v1/2023-04-10/scim/create-a-user"},{"title":"Search User","deprecated":true,"version":null,"sidebarTitle":"Search User","openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-user"},{"title":"Search Users","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Users/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-users"},{"title":"Get a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/get-a-user-by-id"},{"title":"Update a user by supplying all values of the user object","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/update-a-user-by-supplying-all-values-of-the-user-object"},{"title":"Delete a user based on ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/scim/v2/Users/{id}","href":"/docs/api/cloud/v1/2023-04-10/scim/delete-a-user-based-on-id"},{"title":"Search for a user by ID","deprecated":true,"version":null,"sidebarTitle":"Search for a user by ID","openapi":"/openapi/cloud/2023-04-10.json put /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-for-a-user-by-id"},{"title":"Search for a user by ID","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/scim/v2/Users/{id}/.search","href":"/docs/api/cloud/v1/2023-04-10/scim/search-for-a-user-by-id-1"}]},{"group":"API Keys","pages":[{"title":"List API Keys","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/api-keys","href":"/docs/api/cloud/v1/2023-04-10/api-keys/list-api-keys"},{"title":"Create a new API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/api-keys","href":"/docs/api/cloud/v1/2023-04-10/api-keys/create-a-new-api-key"},{"title":"Get an API Key by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2023-04-10/api-keys/get-an-api-key-by-id"},{"title":"Delete an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2023-04-10/api-keys/delete-an-api-key"},{"title":"Update an API Key","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/api-keys/{id}","href":"/docs/api/cloud/v1/2023-04-10/api-keys/update-an-api-key"}]},{"group":"OpenID Connect Configuration","pages":[{"title":"List all API OIDC configurations","deprecated":true,"version":null,"sidebarTitle":"List all API OIDC configurations","tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/api_oidc","href":"/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/list-all-api-oidc-configurations"},{"title":"Create an API OIDC configuration","deprecated":true,"version":null,"sidebarTitle":"Create an API OIDC configuration","tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/api_oidc","href":"/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/create-an-api-oidc-configuration"},{"title":"Get an API OIDC configuration","deprecated":true,"version":null,"sidebarTitle":"Get an API OIDC configuration","tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/api_oidc/{id}","href":"/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/get-an-api-oidc-configuration"},{"title":"Update an API OIDC configuration","deprecated":true,"version":null,"sidebarTitle":"Update an API OIDC configuration","tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json put /api/v1/api_oidc/{id}","href":"/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/update-an-api-oidc-configuration"},{"title":"Delete an API OIDC configuration","deprecated":true,"version":null,"sidebarTitle":"Delete an API OIDC configuration","tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/api_oidc/{id}","href":"/docs/api/cloud/v1/2023-04-10/openid-connect-configuration/delete-an-api-oidc-configuration"}]},{"group":"Audit Logs","pages":[{"title":"List audit logs","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/auditlogevents","href":"/docs/api/cloud/v1/2023-04-10/audit-logs/list-audit-logs"}]},{"group":"Clusters","pages":[{"title":"List available major cluster versions","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/cluster-versions","href":"/docs/api/cloud/v1/2023-04-10/clusters/list-available-major-cluster-versions"},{"title":"List clusters owned by an organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters","href":"/docs/api/cloud/v1/2023-04-10/clusters/list-clusters-owned-by-an-organization"},{"title":"Create and initialize a new cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters","href":"/docs/api/cloud/v1/2023-04-10/clusters/create-and-initialize-a-new-cluster"},{"title":"List the regions available for new clusters and nodes","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/available-regions","href":"/docs/api/cloud/v1/2023-04-10/clusters/list-the-regions-available-for-new-clusters-and-nodes"},{"title":"Get extended information about a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2023-04-10/clusters/get-extended-information-about-a-cluster"},{"title":"Delete a cluster and all of its data","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2023-04-10/clusters/delete-a-cluster-and-all-of-its-data"},{"title":"Scale, edit or upgrade a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2023-04-10/clusters/scale-edit-or-upgrade-a-cluster"},{"title":"Get a formatted generic connection string for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/connection-string","href":"/docs/api/cloud/v1/2023-04-10/clusters/get-a-formatted-generic-connection-string-for-a-cluster"},{"title":"List nodes for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/nodes","href":"/docs/api/cloud/v1/2023-04-10/clusters/list-nodes-for-a-cluster"}]},{"group":"Client CA Certificates","pages":[{"title":"Get Client CA Cert information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2023-04-10/client-ca-certificates/get-client-ca-cert-information-for-a-cluster"},{"title":"Set Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2023-04-10/client-ca-certificates/set-client-ca-cert-for-a-cluster"},{"title":"Delete Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2023-04-10/client-ca-certificates/delete-client-ca-cert-for-a-cluster"},{"title":"Update Client CA Cert for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2023-04-10/client-ca-certificates/update-client-ca-cert-for-a-cluster"}]},{"group":"Customer-managed Encryption Keys","pages":[{"title":"Get CMEK-related information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/get-cmek-related-information-for-a-cluster"},{"title":"Enable or update the CMEK spec for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/enable-or-update-the-cmek-spec-for-a-cluster"},{"title":"Enable CMEK for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/enable-cmek-for-a-cluster"},{"title":"Update the CMEK-related status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2023-04-10/customer-managed-encryption-keys/update-the-cmek-related-status-for-a-cluster"}]},{"group":"Databases","pages":[{"title":"List databases for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2023-04-10/databases/list-databases-for-a-cluster"},{"title":"Create a new database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2023-04-10/databases/create-a-new-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2023-04-10/databases/update-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2023-04-10/databases/delete-a-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2023-04-10/databases/update-a-database-1"}]},{"group":"Log Export","pages":[{"title":"Get the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2023-04-10/log-export/get-the-log-export-configuration-for-a-cluster"},{"title":"Create or update the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2023-04-10/log-export/create-or-update-the-log-export-configuration-for-a-cluster"},{"title":"Delete the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2023-04-10/log-export/delete-the-log-export-configuration-for-a-cluster"}]},{"group":"Maintenance Windows","pages":[{"title":"Get the maintenance window for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2023-04-10/maintenance-windows/get-the-maintenance-window-for-a-cluster"},{"title":"Set the maintenance window for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json put /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2023-04-10/maintenance-windows/set-the-maintenance-window-for-a-cluster"},{"title":"Delete the maintenance window for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/maintenance-window","href":"/docs/api/cloud/v1/2023-04-10/maintenance-windows/delete-the-maintenance-window-for-a-cluster"}]},{"group":"Metric Export","pages":[{"title":"Get the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2023-04-10/metric-export/get-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Create or update the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2023-04-10/metric-export/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Delete the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2023-04-10/metric-export/delete-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Get the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2023-04-10/metric-export/get-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Create or update the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2023-04-10/metric-export/create-or-update-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Delete the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2023-04-10/metric-export/delete-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Get the Prometheus Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2023-04-10/metric-export/get-the-prometheus-metric-export-configuration-for-a-cluster"},{"title":"Enable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2023-04-10/metric-export/enable-prometheus-metric-export-for-a-cluster"},{"title":"Disable Prometheus Metric Export for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/metricexport/prometheus","href":"/docs/api/cloud/v1/2023-04-10/metric-export/disable-prometheus-metric-export-for-a-cluster"}]},{"group":"IP Allowlists","pages":[{"title":"Get the IP allowlist and propagation status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2023-04-10/ip-allowlists/get-the-ip-allowlist-and-propagation-status-for-a-cluster"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2023-04-10/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2023-04-10/ip-allowlists/add-a-new-cidr-address-to-the-ip-allowlist-1"},{"title":"Delete an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2023-04-10/ip-allowlists/delete-an-ip-allowlist-entry"},{"title":"Update an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2023-04-10/ip-allowlists/update-an-ip-allowlist-entry"}]},{"group":"Private Endpoint Services","pages":[{"title":"List all AwsEndpointConnections for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-awsendpointconnections-for-a-cluster"},{"title":"Set the AWS Endpoint Connection state","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/set-the-aws-endpoint-connection-state"},{"title":"List all connections to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-connections-to-a-clusters-private-endpoint-service"},{"title":"Add a connection to a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/add-a-connection-to-a-clusters-private-endpoint-service"},{"title":"Delete a connection from a cluster's private endpoint service.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/delete-a-connection-from-a-clusters-private-endpoint-service"},{"title":"List all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-privateendpointservices-for-a-cluster"},{"title":"Create all PrivateEndpointServices for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/create-all-privateendpointservices-for-a-cluster"},{"title":"List all private endpoint trusted owners for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/list-all-private-endpoint-trusted-owners-for-a-cluster"},{"title":"Add a private endpoint trusted owner to a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/add-a-private-endpoint-trusted-owner-to-a-cluster"},{"title":"Get a private endpoint trusted owner entry for a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/get-a-private-endpoint-trusted-owner-entry-for-a-cluster"},{"title":"Remove a private endpoint trusted owner from a cluster","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/networking/private-endpoint-trusted-owners/{owner_id}","href":"/docs/api/cloud/v1/2023-04-10/private-endpoint-services/remove-a-private-endpoint-trusted-owner-from-a-cluster"}]},{"group":"Egress Rules","pages":[{"title":"List all egress rules associated with a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/list-all-egress-rules-associated-with-a-cluster"},{"title":"Add an egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/add-an-egress-rule"},{"title":"Outbound traffic management","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/networking/egress-rules/egress-traffic-policy","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/outbound-traffic-management"},{"title":"Get an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/get-an-existing-egress-rule"},{"title":"Delete an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/delete-an-existing-egress-rule"},{"title":"Edit an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2023-04-10/egress-rules/edit-an-existing-egress-rule"}]},{"group":"SQL Users","pages":[{"title":"List SQL users for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2023-04-10/sql-users/list-sql-users-for-a-cluster"},{"title":"Create a new SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2023-04-10/sql-users/create-a-new-sql-user"},{"title":"Delete a SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/clusters/{cluster_id}/sql-users/{name}","href":"/docs/api/cloud/v1/2023-04-10/sql-users/delete-a-sql-user"},{"title":"Update a SQL user's password","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/v1/clusters/{cluster_id}/sql-users/{name}/password","href":"/docs/api/cloud/v1/2023-04-10/sql-users/update-a-sql-users-password"}]},{"group":"Version Deferral","pages":[{"title":"Get the version upgrade deferral policy for a cluster.","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/2023-04-10/version-deferral/get-the-version-upgrade-deferral-policy-for-a-cluster"},{"title":"Set the version upgrade deferral policy for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json put /api/v1/clusters/{cluster_id}/version-deferral","href":"/docs/api/cloud/v1/2023-04-10/version-deferral/set-the-version-upgrade-deferral-policy-for-a-cluster"}]},{"group":"Folders","pages":[{"title":"List folders owned by an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/folders","href":"/docs/api/cloud/v1/2023-04-10/folders/list-folders-owned-by-an-organization"},{"title":"Create a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/folders","href":"/docs/api/cloud/v1/2023-04-10/folders/create-a-folder"},{"title":"Get folder info for a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2023-04-10/folders/get-folder-info-for-a-folder"},{"title":"Delete a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2023-04-10/folders/delete-a-folder"},{"title":"Update a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/folders/{folder_id}","href":"/docs/api/cloud/v1/2023-04-10/folders/update-a-folder"},{"title":"List contents of a folder","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/folders/{folder_id}/contents","href":"/docs/api/cloud/v1/2023-04-10/folders/list-contents-of-a-folder"}]},{"group":"Billing","pages":[{"title":"List invoices for a given organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/invoices","href":"/docs/api/cloud/v1/2023-04-10/billing/list-invoices-for-a-given-organization"},{"title":"Get a specific invoice for an organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/invoices/{invoice_id}","href":"/docs/api/cloud/v1/2023-04-10/billing/get-a-specific-invoice-for-an-organization"}]},{"group":"JWT Issuers","pages":[{"title":"List all JWT Issuers","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/2023-04-10/jwt-issuers/list-all-jwt-issuers"},{"title":"Add a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/jwt-issuers","href":"/docs/api/cloud/v1/2023-04-10/jwt-issuers/add-a-jwt-issuer"},{"title":"Get a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2023-04-10/jwt-issuers/get-a-jwt-issuer"},{"title":"Delete a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2023-04-10/jwt-issuers/delete-a-jwt-issuer"},{"title":"Update a JWT Issuer","deprecated":null,"version":null,"tag":"Limited Access","openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/jwt-issuers/{id}","href":"/docs/api/cloud/v1/2023-04-10/jwt-issuers/update-a-jwt-issuer"}]},{"group":"Organizations","pages":[{"title":"Get information about the caller's organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/organization","href":"/docs/api/cloud/v1/2023-04-10/organizations/get-information-about-the-callers-organization"}]},{"group":"Role Management","pages":[{"title":"List all RoleGrants","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/roles","href":"/docs/api/cloud/v1/2023-04-10/role-management/list-all-rolegrants"},{"title":"Get all Role Grants for a user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2023-04-10/role-management/get-all-role-grants-for-a-user"},{"title":"Replace the roles for a user or service account with exactly those provided","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json put /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2023-04-10/role-management/replace-the-roles-for-a-user-or-service-account-with-exactly-those-provided"},{"title":"Add a role to a user or service account","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json post /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2023-04-10/role-management/add-a-role-to-a-user-or-service-account"},{"title":"Remove a role from a user or service account","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2023-04-10/role-management/remove-a-role-from-a-user-or-service-account"},{"title":"Search person users by email address","deprecated":null,"version":null,"openapi":"/openapi/cloud/2023-04-10.json get /api/v1/users/persons-by-email","href":"/docs/api/cloud/v1/2023-04-10/role-management/search-person-users-by-email-address"}]},{"group":"Service Accounts","pages":[{"title":"List service accounts for an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/service-accounts","href":"/docs/api/cloud/v1/2023-04-10/service-accounts/list-service-accounts-for-an-organization"},{"title":"Create a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json post /api/v1/service-accounts","href":"/docs/api/cloud/v1/2023-04-10/service-accounts/create-a-service-account"},{"title":"Get a service account by ID","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json get /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2023-04-10/service-accounts/get-a-service-account-by-id"},{"title":"Delete a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json delete /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2023-04-10/service-accounts/delete-a-service-account"},{"title":"Update a service account","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2023-04-10.json patch /api/v1/service-accounts/{id}","href":"/docs/api/cloud/v1/2023-04-10/service-accounts/update-a-service-account"}]}]}]},{"dropdown":"2022-09-20","icon":"books","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cloud API","href":"/docs/api/cloud/2022-09-20"}]},{"group":"Endpoints","pages":[{"group":"CockroachCloud","pages":[{"title":"List available major cluster versions","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/cluster-versions","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-available-major-cluster-versions"},{"title":"List clusters owned by an organization","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-clusters-owned-by-an-organization"},{"title":"Create and initialize a new cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-and-initialize-a-new-cluster"},{"title":"List the regions available for new clusters and nodes","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/available-regions","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-the-regions-available-for-new-clusters-and-nodes"},{"title":"Get extended information about a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-extended-information-about-a-cluster"},{"title":"Delete a cluster and all of its data","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-cluster-and-all-of-its-data"},{"title":"Scale or edit a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/scale-or-edit-a-cluster"},{"title":"Get Client CA Cert information for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-client-ca-cert-information-for-a-cluster"},{"title":"Set Client CA Cert for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/set-client-ca-cert-for-a-cluster"},{"title":"Delete Client CA Cert for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-client-ca-cert-for-a-cluster"},{"title":"Update Client CA Cert for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/client-ca-cert","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-client-ca-cert-for-a-cluster"},{"title":"Get CMEK-related information for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-cmek-related-information-for-a-cluster"},{"title":"Enable or update the CMEK spec for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json put /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/enable-or-update-the-cmek-spec-for-a-cluster"},{"title":"Enable CMEK for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/enable-cmek-for-a-cluster"},{"title":"Update the CMEK-related status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-the-cmek-related-status-for-a-cluster"},{"title":"Get a formatted generic connection string for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/connection-string","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-a-formatted-generic-connection-string-for-a-cluster"},{"title":"List databases for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-databases-for-a-cluster"},{"title":"Create a new database","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-a-new-database"},{"title":"Update a database","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/databases","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-database"},{"title":"Delete a database","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-database"},{"title":"Update a database","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/databases/{name}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-database-1"},{"title":"Get the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-log-export-configuration-for-a-cluster"},{"title":"Create or update the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-log-export-configuration-for-a-cluster"},{"title":"Delete the Log Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/logexport","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-log-export-configuration-for-a-cluster"},{"title":"Get the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Create or update the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Delete the CloudWatch Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/metricexport/cloudwatch","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-cloudwatch-metric-export-configuration-for-a-cluster"},{"title":"Get the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Create or update the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-or-update-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Delete the Datadog Metric Export configuration for a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/metricexport/datadog","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-the-datadog-metric-export-configuration-for-a-cluster"},{"title":"Get the IP allowlist and propagation status for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-the-ip-allowlist-and-propagation-status-for-a-cluster"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist"},{"title":"Delete an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-an-ip-allowlist-entry"},{"title":"Add a new CIDR address to the IP allowlist","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json put /api/v1/clusters/{cluster_id}/networking/allowlist/{entry.cidr_ip}/{entry.cidr_mask}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist-1"},{"title":"Update an IP allowlist entry","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/networking/allowlist/{entry.cidr_ip}/{entry.cidr_mask}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-an-ip-allowlist-entry"},{"title":"Lists all AwsEndpointConnections for a given cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-awsendpointconnections-for-a-given-cluster"},{"title":"Sets the AWS Endpoint Connection state based on what is passed in the body","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/networking/aws-endpoint-connections/{endpoint_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/sets-the-aws-endpoint-connection-state-based-on-what-is-passed-in-the-body"},{"title":"List all egress rules associates with a cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-all-egress-rules-associates-with-a-cluster"},{"title":"Add an egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/networking/egress-rules","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/add-an-egress-rule"},{"title":"Outbound traffic management","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/networking/egress-rules/egress-traffic-policy","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/outbound-traffic-management"},{"title":"Get an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-an-existing-egress-rule"},{"title":"Delete an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-an-existing-egress-rule"},{"title":"Edit an existing egress rule","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json patch /api/v1/clusters/{cluster_id}/networking/egress-rules/{rule_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/edit-an-existing-egress-rule"},{"title":"Lists all PrivateEndpointServices for a given cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-privateendpointservices-for-a-given-cluster"},{"title":"Creates all PrivateEndpointServices for a given cluster","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/networking/private-endpoint-services","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/creates-all-privateendpointservices-for-a-given-cluster"},{"title":"List nodes for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/nodes","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-nodes-for-a-cluster"},{"title":"List SQL users for a cluster","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json get /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-sql-users-for-a-cluster"},{"title":"Create a new SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json post /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/create-a-new-sql-user"},{"title":"Delete a SQL user","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/clusters/{cluster_id}/sql-users/{name}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/delete-a-sql-user"},{"title":"Update a SQL user's password","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-09-20.json put /api/v1/clusters/{cluster_id}/sql-users/{name}/password","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/update-a-sql-users-password"},{"title":"List invoices for a given organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/invoices","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/list-invoices-for-a-given-organization"},{"title":"Gets a specific invoice for an organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/invoices/{invoice_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/gets-a-specific-invoice-for-an-organization"},{"title":"Get information about the caller's organization","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/organization","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/get-information-about-the-callers-organization"},{"title":"Lists all RoleGrants","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/roles","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/lists-all-rolegrants"},{"title":"Gets All Role Grants for the specified user","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json get /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/gets-all-role-grants-for-the-specified-user"},{"title":"Makes the users roles exactly those provided","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json put /api/v1/roles/{user_id}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/makes-the-users-roles-exactly-those-provided"},{"title":"Adds the user to the given role","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json post /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/adds-the-user-to-the-given-role"},{"title":"Removes the user from the given role","deprecated":null,"version":null,"tag":"Preview","openapi":"/openapi/cloud/2022-09-20.json delete /api/v1/roles/{user_id}/{resource_type}/{resource_id}/{role_name}","href":"/docs/api/cloud/v1/2022-09-20/cockroachcloud/removes-the-user-from-the-given-role"}]}]}]},{"dropdown":"2022-03-31","icon":"books","groups":[{"group":"Overview","pages":[{"title":"CockroachDB Cloud API","href":"/docs/api/cloud/2022-03-31"}]},{"group":"Endpoints","pages":[{"group":"CockroachCloud","pages":[{"title":"List clusters owned by an organization.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-clusters-owned-by-an-organization"},{"title":"Create and initialize a new cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json post /api/v1/clusters","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/create-and-initialize-a-new-cluster"},{"title":"List the regions available for new clusters and nodes.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/available-regions","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-the-regions-available-for-new-clusters-and-nodes"},{"title":"Get extended information about a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-extended-information-about-a-cluster"},{"title":"Delete a cluster and all of its data.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json delete /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-a-cluster-and-all-of-its-data"},{"title":"Scale or edit a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json patch /api/v1/clusters/{cluster_id}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/scale-or-edit-a-cluster"},{"title":"Get CMEK-related information for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-cmek-related-information-for-a-cluster"},{"title":"Enable CMEK for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json post /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/enable-cmek-for-a-cluster"},{"title":"Update the CMEK-related status for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json patch /api/v1/clusters/{cluster_id}/cmek","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-the-cmek-related-status-for-a-cluster"},{"title":"Get the IP allowlist and propagation status for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/get-the-ip-allowlist-and-propagation-status-for-a-cluster"},{"title":"Add a new CIDR address to the IP allowlist.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json post /api/v1/clusters/{cluster_id}/networking/allowlist","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist"},{"title":"Delete an IP allowlist entry.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json delete /api/v1/clusters/{cluster_id}/networking/allowlist/{cidr_ip}/{cidr_mask}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-an-ip-allowlist-entry"},{"title":"Add a new CIDR address to the IP allowlist.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json put /api/v1/clusters/{cluster_id}/networking/allowlist/{entry.cidr_ip}/{entry.cidr_mask}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/add-a-new-cidr-address-to-the-ip-allowlist-1"},{"title":"Update an IP allowlist entry.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json patch /api/v1/clusters/{cluster_id}/networking/allowlist/{entry.cidr_ip}/{entry.cidr_mask}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-an-ip-allowlist-entry"},{"title":"List nodes for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/{cluster_id}/nodes","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-nodes-for-a-cluster"},{"title":"List SQL users for a cluster.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json get /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/list-sql-users-for-a-cluster"},{"title":"Create a new SQL user.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json post /api/v1/clusters/{cluster_id}/sql-users","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/create-a-new-sql-user"},{"title":"Delete a SQL user.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json delete /api/v1/clusters/{cluster_id}/sql-users/{name}","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/delete-a-sql-user"},{"title":"Update a SQL user's password.","deprecated":null,"version":null,"openapi":"/openapi/cloud/2022-03-31.json put /api/v1/clusters/{cluster_id}/sql-users/{name}/password","href":"/docs/api/cloud/v1/2022-03-31/cockroachcloud/update-a-sql-users-password"}]}]}]}]}]},{"product":"Releases","icon":"list","description":"Version history, support policy \u0026 advisories","pages":[{"title":"Releases","href":"/docs/releases"}]}]},"title":"Disable runtime scanning on a cluster. - CockroachDB","buildId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","deploymentId":"dpl_cadrRc5H9XQiJQbDFN5mcYRs2PAj","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DKJwRUt2.js","utils-CWD_VS3u.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-oFjciODD.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-C76WsxC3.js","snippetPresets-DvPMxpX_.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CuNQfndH.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BVFpVUoF.js","shallow-t59Jg5Kr.js","getApiPlaygroundDisplay-C_JZ4amX.js","CodeSnippet-CLRDnx_h.js","CodeSnippets-C2myU4kc.js","Page-7TwLLapg.js","getPastedJson-B-JaVXw7.js","icon-BA-iDhH3.js","MethodPill-D4qZABFp.js","DuplicateIcon-THIDKO1O.js","createIcon-CYYJwgFd.js","DynamicMarkdown-UGQuxDKp.js","SectionHeading-jYELb23h.js","axios-vUo_bRtp.js","Markdown-DKsLa3wy.js","clsx-CefdjKz2.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BaREnp3o.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-sgx_0XzF.js"]}