This page provides guidance for planning and estimating costs for a CockroachDB Standard cluster that meets your business requirements. For information on diagnosing and optimizing your resource consumption, see Optimize your Resource Usage.
The compute resources available to a CockroachDB Standard cluster is provisioned and scaled using a capacity model measured in virtual CPUs (vCPUs). A cluster’s capacity requirements depend on the scale and query profile of the cluster’s workload, and may change over time as the workload evolves. It’s typical to estimate the initial compute capacity needed for a workload before creating the cluster, and to adjust the capacity up or down based observation of the workload’s consumption.Storage for a CockroachDB Standard cluster is allocated on demand and is not covered in this section. Refer to Storage.
To achieve a rough initial estimate of compute capacity, consider:
Expected workload maximum: the maximum expected long-term compute consumption for the workload, measured in vCPUs.
If your workload is already using CockroachDB self-hosted and is performing well, we recommend that you start with the sum of the compute capacity of its nodes across all regions.
If you are moving the workload from another database and is performing well, we recommend that you consider its historical compute requirements to arrive at an initial compute capacity.
Talk to an expert. Engineers at Cockroach Labs will work with you to understand the resource demands of your workload and help you estimate and validate its required capacity.
Additional capacity buffer: To accommodate unanticipated load and mitigate the risk of application degradation if the cluster’s capacity is exceeded, we recommend that you plan for additional capacity beyond your initial estimate. A 40% buffer is a good starting point, but more may be needed if the workload is unpredictable or highly sensitive to query latency. Depending on the nature of the workload, such as when demand is seasonal, you can plan to scale the cluster’s capacity temporarily to address the workload’s requirements.
Exceeding capacity limit: CockroachDB Standard enforces the cluster’s provisioned capacity, limiting application throughput if the workload exceeds the cluster’s provisioned capacity. This can lead to increased query latency and degraded application performance.
Notifications to prevent overrun: To help mitigate against the risk of exceeding a cluster’s capacity, email and CockroachDB Cloud Console notifications will occur when a cluster workload exceeds 70% and 90% of its provisioned capacity.
Multi-region deployments: The provisioned capacity of your cluster applies to the entire cluster, regardless of the number of nodes or regional topography. The provisioned capacity is effectively a budget for the cluster that can be used by a node in any region to meet its compute demand. This simplifies planning compute capacity for multi-region deployments. The overall compute capacity cost for a multi-region CockroachDB Standard cluster is calculated based on the price of the most expensive region in the cluster.
You can decrease the provisioned capacity only three times within a 7-day period. You can increase the provisioned capacity at any time.
The CockroachDB Cloud Console provides insight into your cluster’s compute usage relative to its provisioned capacity on a monthly basis. We recommend that you maintain at minimum a 40% capacity buffer over time, and that you increase this buffer if the workload is unpredictable or highly sensitive to query latency. You now have the advantage of historical data about the cluster’s performance to help you maintain and improve the cluster’s performance over time.
Recommended provisioned capacity when changing cluster plan
If you change your cluster’s plan from Basic to Standard, the Cloud Console will provide a suggested provisioned capacity. This is calculated based on your peak request units (RU/sec) in the last 30 days on the Basic cluster plan. The vCPU suggestion is based on the 30-day peak RU/sec with an additional 40% buffer. 500 RU/sec equates to 1 vCPU. There is a 10-minute roll-up period for the peak RU/sec. If the estimate is beyond the Standard plan’s maximum supported vCPU, you may experience performance issues if your cluster’s workload consistently spikes above that level.
Important capacity and pricing policies mentioned elsewhere are summarized here:
Minimum and maximum provisioned capacity: A CockroachDB Standard cluster must have a provisioned capacity of at minimum 2 vCPUs. For production workloads, we recommend at minimum 4 to 8 vCPUs. The maximum capacity for CockroachDB Standard is 200 vCPUs. To express interest in higher-capacity clusters, talk to an expert.
Enforcing provisioned capacity limits: CockroachDB Cloud enforces the cluster’s provisioned capacity, limiting application throughput if the workload exceeds the capacity limit. This can result in degraded performance and increased query latency. You can increase a cluster’s capacity at any time.
Capacity for multi-region clusters: A multi-region cluster’s capacity is available to all cluster nodes in all regions, but is not pre-allocated per region. The cluster’s CPU utilization across regions cannot exceed its provisioned capacity.
Multi-region pricing by the most expensive region: The overall compute capacity cost for a multi-region CockroachDB Standard cluster is calculated based on the price of the most expensive region in the cluster.
Limitations on capacity scaling: You can decrease the provisioned capacity only three times within a 7-day period. You can increase the provisioned capacity at any time.
We recommend that you start with Quickstart: Provision and adjust capacity to arrive at the best initial compute capacity for your workload and that you adjust the cluster’s capacity over time as the workload evolves. In addition, consider the following:
Smaller workloads: CockroachDB Standard is well suited for workloads that require 12 or fewer vCPUs. By contrast, 12 vCPUs (3 nodes x 4 vCPUs) is the minimum configuration for CockroachDB Advanced.
CockroachDB Standard is not recommended for:
Analytical workloads that involve many large, complex reads
OLAP or hybrid OLTP/OLAP applications
Asymmetric multi-region workloads: Often, multi-region deployments are asymmetric in terms of CPU utilization across regions. For example, in a three-region cluster, two of the three regions may require more capacity than the third, or vice versa. In CockroachDB Standard, a cluster’s compute capacity is available in all regions.For workloads that require asymmetric capacity per region or where a given region must maintain a given compute capacity, CockroachDB Advanced may be a better option.
Workloads that are sensitive to latency: CockroachDB Standard clusters use a different networking architecture than CockroachDB Advanced. This architecture can introduce additional query latency of around 1 microsecond when compared with CockroachDB Advanced.
Workloads with advanced security or compliance requirements: For workloads subject to advanced security or compliance requirements, consider CockroachDB Advanced, which complies with PCI DSS and HIPAA. To learn more refer to Compliance in CockroachDB Cloud.
For more details to help you compare CockroachDB Cloud cluster plans, refer to CockroachDB Cloud Overview.
Storage capacity for a CockroachDB Standard cluster is priced on demand in units of GiB-month. Storage prices vary across providers and regions. Storage is charged based on the logical amount of data in the database.
3 replicas included: CockroachDB Standard maintains at minimum three replicas of your data at no additional cost.
For a cluster with more than three replicas, storage for each additional replica is priced at the storage price for the region.
Multi-region storage: In a multi-region cluster, storage prices vary by region. The data in each region is priced at that region’s storage rate.
By default, CockroachDB Cloud maintains three replicas for a single-region cluster, spread across three different availability zones within the region. You are not charged to store these replicas.For example, if a single-region cluster is deployed in us-central-1 and contains 500 GiB of data. CockroachDB Cloud stores three replicas, for a total of 1500 GiB of data. However, you are billed only for 500 GiB of storage.If you add a fourth replica, the cluster consumes 2000 GiB of storage (500 x 4), but you are billed only for 1000 GiB (500 for the data and 500 for the fourth replica).
For multi-region clusters, we recommend that 5 or more replicas are maintained across availability zones and regions for resilience against both zone and region failure. The first three replicas are included in the base storage price, while additional replicas are priced based on the ratio of additional regions to the initial three.Consider the example of a three-region cluster with 500 GiB of logical data, deployed in us-central1, us-west2, and europe-west1, with 5 replicas. The logical data and the first three replicas are included in the monthly storage cost. The additional two replicas are charged at 2/3 of the monthly storage cost. This cluster consumes 2500 GiB of storage, but is billed for 1500 GiB for the initial data and 3 replicas, plus 2/3 of the additional 1000 GiB for the additional two replicas (2 replicas beyond the initial 3).If you add a 6th replica, the cluster will consume 3000 GiB (500 x 6), and will be billed for 1500 GiB for the initial data and 3 replicas, plus 100% (3/3) of the additional three replicas (3 replicas beyond the initial 3).
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"CockroachDB","colors":{"primary":"#9059FF","light":"#9059FF","dark":"#9059FF"},"logo":{"light":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_Black.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=54ccae625c9986bf1df8ddc7b2c571f0","dark":"https://mintcdn.com/cockroachlabs/4WvUnbVuGZfqM4kW/images/CockroachLabs_Wordmark_White.png?fit=max\u0026auto=format\u0026n=4WvUnbVuGZfqM4kW\u0026q=85\u0026s=0dd9b66973a1c7d3dd72aa67b6094efe","href":"https://www.cockroachlabs.com/"},"favicon":{"light":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551","dark":"https://mintcdn.com/cockroachlabs/2yihO7vMXnL0G_07/images/favicon.svg?fit=max\u0026auto=format\u0026n=2yihO7vMXnL0G_07\u0026q=85\u0026s=01f9aa59c9f275e1f35cd424a27d2551"},"api":{"examples":{"defaults":"required","languages":["curl"]}},"appearance":{"default":"light"},"navbar":{"primary":{"type":"button","label":"Get started free","href":"https://cockroachlabs.cloud/signup?referralId=cc_nav_global\u0026_ga=2.242886210.1147139380.1759903632-41552699.1759903632"}},"footer":{"socials":{"youtube":"https://www.youtube.com/@cockroachdb","x":"https://x.com/CockroachDB","linkedin":"https://www.linkedin.com/company/cockroach-labs/mycompany/verification","instagram":"https://www.instagram.com/cockroachdb"},"links":[{"header":"Product","items":[{"label":"CockroachDB","href":"https://www.cockroachlabs.com/product"},{"label":"CockroachDB Cloud","href":"https://www.cockroachlabs.com/product/cockroachcloud"},{"label":"Compare","href":"https://www.cockroachlabs.com/compare"},{"label":"Pricing","href":"https://www.cockroachlabs.com/pricing"},{"label":"Get CockroachDB","href":"https://www.cockroachlabs.com/get-started-cockroachdb"},{"label":"Sign In","href":"https://cockroachlabs.cloud/"}]},{"header":"Resources","items":[{"label":"Guides","href":"https://resources.cockroachlabs.com/guides"},{"label":"Webinars","href":"https://www.cockroachlabs.com/community/webinars"},{"label":"Videos","href":"https://www.cockroachlabs.com/resources/video"},{"label":"Architecture Overview","href":"https://www.cockroachlabs.com/docs/stable/architecture/overview"},{"label":"FAQ","href":"https://www.cockroachlabs.com/docs/stable/frequently-asked-questions"},{"label":"Security","href":"https://www.cockroachlabs.com/security"}]},{"header":"Learn \u0026 Support","items":[{"label":"Docs","href":"https://www.cockroachlabs.com/docs"},{"label":"University","href":"https://learn.cockroachlabs.com/"},{"label":"Developers","href":"https://www.cockroachlabs.com/developers"},{"label":"Forum","href":"https://forum.cockroachlabs.com/"},{"label":"Slack","href":"https://cockroa.ch/slack"},{"label":"Support Portal","href":"https://support.cockroachlabs.com/hc/en-us"},{"label":"Contact Us","href":"https://www.cockroachlabs.com/contact"}]},{"header":"Company","items":[{"label":"About","href":"https://www.cockroachlabs.com/about"},{"label":"Blog","href":"https://www.cockroachlabs.com/blog"},{"label":"Careers","href":"https://www.cockroachlabs.com/careers"},{"label":"Customers","href":"https://www.cockroachlabs.com/customers"},{"label":"News","href":"https://www.cockroachlabs.com/press"},{"label":"Privacy","href":"https://www.cockroachlabs.com/privacy"},{"label":"Terms of Use","href":"https://www.cockroachlabs.com/website-terms-of-use"}]}]},"fonts":{"heading":{"family":"Poppins"},"body":{"family":"Open Sans"}},"styling":{"eyebrows":"breadcrumbs","codeblocks":{"theme":{"light":"catppuccin-mocha","dark":"catppuccin-mocha"}},"latex":true},"integrations":{"gtm":{"tagId":"GTM-NR8LC4"}},"errors":{"404":{"redirect":false,"title":"Page not found","description":"The page you're looking for doesn't exist. [Return to docs home](/index.html)."}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"interaction":{"drilldown":false},"navigation":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"cockroachlabs","hasAudioNarration":false,"actualSubdomain":"cockroachlabs","customDomains":["docs.cockroachlabs.com"],"gitSource":{"type":"github","owner":"cockroachlabs","repo":"docs","deployBranch":"main","contentDirectory":"cockroachlabs-preview-main","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af4bb21d7a808c67a4ac795","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"CockroachDB","count":6951},{"language":"default","tag":"Docs","count":3217},{"language":"default","tag":"SQL","count":2566},{"language":"default","tag":"Statements","count":1714},{"language":"default","tag":"Self-Hosted Deployments","count":1457},{"language":"default","tag":"Reference","count":774},{"language":"default","tag":"Cloud Deployments","count":616},{"language":"default","tag":"Endpoints","count":528},{"language":"default","tag":"Cloud API Reference","count":518},{"language":"default","tag":"Get Started","count":441}],"searchSettings":{"isFiltersEnabled":true,"showContentSnippets":true,"fullPageSearch":true}},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":true,"toggles":[],"googleFontsInlined":true},"customCss":[{"filePath":"styles.css","content":":root{--inline-code-bg-light: rgb(var(--gray-200) / 0.92);--inline-code-bg-dark: rgb(255 255 255 / 0.08)}.prose :not(pre)>code{background-color:var(--inline-code-bg-light)!important}.dark .prose :not(pre)>code{background-color:var(--inline-code-bg-dark)!important}@media (min-width: 1536px){#navbar>.max-w-8xl,[class*=\"peer-[.is-not-custom]:peer-[.is-not-center]:max-w-8xl\"]{width:100%!important;max-width:none!important}}#navigation-items{display:flex;flex-direction:column}#navigation-items>ul:not(.sidebar-group){order:1;margin-top:1.5rem}.crdb-metrics-table table{table-layout:fixed!important;width:100%!important;min-width:0!important;max-width:100%!important;border-collapse:collapse}.crdb-metrics-table table td,.crdb-metrics-table table th{min-width:0!important;overflow-wrap:anywhere;word-break:break-word}.crdb-fixed-table table{table-layout:fixed!important;width:100%!important;min-width:0!important;max-width:100%!important;border-collapse:collapse}.crdb-fixed-table table td,.crdb-fixed-table table th{min-width:0!important;overflow-wrap:anywhere;word-break:break-word}.bg-cover{background-size:cover;background-repeat:no-repeat;background-position:center center}.bg-cover__bg-3-1{background-image:url(\"https://cockroach-labs-docs.imgix.net/bg-3-1.png?auto=format,compress\u0026w=1200\u0026q=40\")}.home-header{border-radius:0.5rem;margin-bottom:2rem!important;padding:2rem}.card{border:1px solid #e5e7eb;border-radius:0.75rem;background-color:white}.dark .card{background-color:#0d1117;border-color:rgba(255, 255, 255, 0.1)}.card-link{text-decoration:none!important;overflow:hidden}.card-link:hover{outline:1px solid rgba(105, 51, 255, 0.55);outline-offset:-1px}.card-link,.card-link:hover{transform:none!important;box-shadow:none!important}.card-link a,.card-link a:hover,.card-link h3,.card-link h3:hover,.card-link p,.card-link p:hover{border:0!important;text-decoration:none!important;transform:none!important}.card-link a{display:block;width:100%}.card-link h3{font-size:1rem!important;font-weight:600!important}.card-body{padding:1.5rem}.landing-column-title{margin-bottom:1rem}.overline{text-transform:uppercase;letter-spacing:0.05em}.btn-redirect{display:inline-flex;align-items:center;gap:0.5rem;padding:0.75rem 1.5rem;border:2px solid #e5e7eb;border-radius:0.5rem;text-decoration:none;transition:border-color 0.2s}.btn-redirect:hover{border-color:#6933ff}.btn-block{display:flex;width:100%;justify-content:center}.dark .btn-redirect{border-color:rgba(255, 255, 255, 0.1)}.article-section-title{font-size:1.25rem!important}.article-lists h3{font-size:0.875rem!important;font-weight:600!important;text-transform:uppercase;letter-spacing:0.05em;color:#6b7280!important}.dark .article-lists h3{color:#9ca3af!important}.article-lists ul{font-size:0.875rem}.shadow{box-shadow:0 0.5rem 1rem rgba(0, 0, 0, 0.15)}.bg-dark-wing{background-color:#152849;border-radius:0.5rem}.text-ice-temple{color:#1bf8ec!important;display:inline-flex;align-items:center;gap:0.375rem}.text-ice-temple img{display:inline-block;margin:0}.bg-dark-wing h2{font-size:clamp(1.25rem, 1rem + 1.5vw, 1.75rem)!important}@media (max-width: 576px){.card-body.bg-dark-wing{padding:1.25rem!important}}.text-decoration-none{text-decoration:none!important}.text-muted{color:#6b7280!important}.card-link .card-desc{font-size:0.9375rem!important;font-weight:400!important;line-height:1.5!important;text-align:left!important;color:#4b5563!important;width:100%;margin-top:0.5rem}.dark .card-link .card-desc{color:#9ca3af!important}.report-tag{display:inline-block;padding:0.25rem 0.75rem;border-radius:0.25rem;background-color:rgba(84, 42, 189, 0.08);color:#542abd}.dark .report-tag{background-color:rgba(84, 42, 189, 0.3);color:#b39dff}.resilience-report-img{background-image:url(\"/images/state-resilience.png\");background-size:cover;background-position:center;min-height:150px;border-radius:0.5rem}.row{display:flex!important;flex-wrap:wrap;margin-left:-0.75rem;margin-right:-0.75rem}.display-flex{display:flex!important}.col-lg-4{flex:0 0 auto;width:100%;padding-left:0.75rem;padding-right:0.75rem}@media (min-width: 992px){.col-lg-4{width:33.333333%!important}}.col-lg-3,.col-sm-6,.col-xs-12{flex:0 0 auto;width:100%!important;padding-left:0.75rem;padding-right:0.75rem}@media (min-width: 992px){.col-lg-3{width:25%!important}}@media (min-width: 576px){.col-sm-6{width:50%!important}}.col-12{width:100%!important}.col-lg-12{width:100%;padding-left:0.75rem;padding-right:0.75rem}@media (min-width: 992px){.col-lg-12{width:100%!important}}.col-md-4,.col-md-8{flex:0 0 auto;width:100%;padding-left:0.75rem;padding-right:0.75rem}@media (min-width: 768px){.col-md-4{width:33.333333%!important}.col-md-8{width:66.666667%!important}}.h-100{height:100%}.d-flex{display:flex}.flex-column{flex-direction:column}.mb-3{margin-bottom:1rem!important}.mb-5{margin-bottom:3rem!important}.pb-5{padding-bottom:3rem!important}.mb-xl-5{margin-bottom:3rem!important}.mt-auto{margin-top:auto!important}.mt-0{margin-top:0!important}.mt-2{margin-top:0.5rem!important}.mt-3{margin-top:1rem!important}.mt-5:not(.code-block){margin-top:3rem!important}.code-block.mb-8{margin-bottom:calc(var(--spacing) * 5)}.pt-5{padding-top:3rem!important}.m-0{margin:0!important}.ml-2{margin-left:0.5rem!important}.mb-0{margin-bottom:0!important}.mb-2{margin-bottom:0.5rem!important}.mb-4{margin-bottom:1.5rem!important}.p-2{padding:0.5rem!important}.p-3{padding:1rem!important}.p-4{padding:1.5rem!important}.pb-3{padding-bottom:1rem!important}.pb-4{padding-bottom:1.5rem!important}.ml-1{margin-left:0.25rem!important}.mr-auto{margin-right:auto!important}.justify-content-center{justify-content:center!important}.align-items-center{align-items:center!important}@media (min-width: 1200px){.p-xl-5{padding:3rem!important}}.mx-0{margin-left:0!important;margin-right:0!important}.text-center{text-align:center}.text-white{color:white!important}.text-black{color:black!important}.dark .text-black{color:white!important}.container{width:100%;max-width:1200px;margin-left:auto;margin-right:auto;padding-left:1rem;padding-right:1rem}.card-header-overlap-text{position:relative}@media (min-width: 768px){.p-md-5{padding:3rem!important}}@media (min-width: 992px){.d-lg-flex{display:flex!important}.mb-lg-0{margin-bottom:0!important}}.prose table{border-collapse:collapse!important}.prose table th,.prose table td{border:1px solid rgb(var(--gray-200))!important}.dark .prose table th,.dark .prose table td{border-color:rgb(var(--gray-700) / 0.5)!important}.prose table th{padding:0.571429em;font-weight:600;vertical-align:bottom;color:var(--tw-prose-headings);text-align:left}.prose table th.center-align{text-align:center}.prose table td{padding:0.571429em;vertical-align:baseline}[data-component-part=\"accordion-description\"]{font-size:0.875rem!important}.accordion.mb-3{margin-bottom:0.25rem!important}@media (max-width: 991.98px){[id^=\"kapa-widget-container\"] button{width:36px!important;height:36px!important;min-width:36px!important;padding:0!important;font-size:0!important}[id^=\"kapa-widget-container\"] button svg{width:18px!important;height:18px!important}[id^=\"kapa-widget-container\"] button span{display:none!important}}table.crdb-fixed-table{table-layout:fixed!important;min-width:0!important;width:100%}table.crdb-fixed-table td,table.crdb-fixed-table th{min-width:0!important;overflow-wrap:break-word;word-break:normal}.sql-grammar svg .line{fill:none;stroke:#262626}.sql-grammar svg .bold-line{stroke:#0A0A0A;shape-rendering:crispEdges;stroke-width:2}.sql-grammar svg .thin-line{stroke:#0F0F0F;shape-rendering:crispEdges}.sql-grammar svg .filled{fill:#262626;stroke:none}.sql-grammar svg text.terminal{font-family:Verdana, Sans-serif;font-size:12px;fill:#0A0A0A;font-weight:bold}.sql-grammar svg text.nonterminal{font-family:Verdana, Sans-serif;font-size:12px;fill:#0055FF}.sql-grammar svg text.regexp{font-family:Verdana, Sans-serif;font-size:12px;fill:#0F0F0F}.sql-grammar svg rect,.sql-grammar svg circle,.sql-grammar svg polygon{fill:#262626;stroke:#262626}.sql-grammar svg rect.terminal{fill:#ffffff;stroke:#262626}.sql-grammar svg rect.nonterminal{fill:#FFFFFF;stroke:#262626}.sql-grammar svg rect.text{fill:none;stroke:none}.sql-grammar svg polygon.regexp{fill:#FFFFFF;stroke:#262626}.sql-grammar svg{background-color:#ffffff}.sql-grammar a[name]::before{content:'';display:block;height:80px;margin:-80px 0 0}.sql-grammar a[name]:focus{outline:0}pre[language=\"sql\"][data-crdb-prompt-stripped] code::before{content:\"> \";color:#94e2d5;user-select:none}.mark-yes{color:#008a5e;font-weight:600}.dark .mark-yes{color:#3ddc97}"},{"filePath":"collapse-nav.css","content":"html:not(.crl-nav-off) [data-layout-item=\"sidebar\"] li[data-title]:not([data-active]):not([data-crl-keep])>button+ul,html:not(.crl-nav-off) [data-layout-item=\"mobile-nav\"] li[data-title]:not([data-active]):not([data-crl-keep])>button+ul{display:none}html:not(.crl-nav-off) [data-layout-item=\"sidebar\"] li[data-title]:not([data-active]):not([data-crl-keep])>button svg,html:not(.crl-nav-off) [data-layout-item=\"mobile-nav\"] li[data-title]:not([data-active]):not([data-crl-keep])>button svg{rotate:none!important;transform:none!important}"}],"page":{"pagePath":"docs/cockroachcloud/plan-your-cluster","slug":"/docs/cockroachcloud/plan-your-cluster","pageMetadata":{"title":"Plan a CockroachDB Standard Cluster","old_description":"Plan your cluster's configuration.","description":null,"href":"/docs/cockroachcloud/plan-your-cluster"},"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`,code:`code`,em:`em`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Tip}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Tip)_missingMdxReference(`Tip`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`This page provides guidance for planning and estimating costs for a CockroachDB Standard cluster that meets your business requirements. For information on diagnosing and optimizing your resource consumption, see `,_jsx(_components.a,{href:`/docs/cockroachcloud/resource-usage`,children:`Optimize your Resource Usage`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`provisioned-capacity`,children:`Provisioned capacity`}),`\n`,_jsxs(_components.p,{children:[`The compute resources available to a CockroachDB Standard cluster is provisioned and scaled using a capacity model measured in `,_jsx(_components.em,{children:`virtual CPUs (vCPUs)`}),`. A cluster’s capacity requirements depend on the scale and query profile of the cluster’s workload, and may change over time as the workload evolves. It’s typical to estimate the initial compute capacity needed for a workload before creating the cluster, and to adjust the capacity up or down based observation of the workload’s consumption.`]}),`\n`,_jsxs(_components.p,{children:[`Storage for a CockroachDB Standard cluster is allocated on demand and is not covered in this section. Refer to `,_jsx(_components.a,{href:`#storage-pricing`,children:`Storage`}),`.`]}),`\n`,_jsx(Heading,{level:`3`,id:`quickstart-provision-and-adjust-capacity`,children:`Quickstart: Provision and adjust capacity`}),`\n`,_jsx(_components.p,{children:`To achieve a rough initial estimate of compute capacity, consider:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Expected workload maximum`}),`: the maximum expected long-term compute consumption for the workload, measured in vCPUs.`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:`If your workload is already using CockroachDB self-hosted and is performing well, we recommend that you start with the sum of the compute capacity of its nodes across all regions.`}),`\n`,_jsx(_components.li,{children:`If you are moving the workload from another database and is performing well, we recommend that you consider its historical compute requirements to arrive at an initial compute capacity.`}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.a,{href:`https://www.cockroachlabs.com/contact`,children:`Talk to an expert`}),`. Engineers at Cockroach Labs will work with you to understand the resource demands of your workload and help you estimate and validate its required capacity.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Additional capacity buffer`}),`: To accommodate unanticipated load and mitigate the risk of application degradation if the cluster’s capacity is exceeded, we recommend that you plan for additional capacity beyond your initial estimate. A 40% buffer is a good starting point, but more may be needed if the workload is unpredictable or highly sensitive to query latency. Depending on the nature of the workload, such as when demand is seasonal, you can plan to scale the cluster’s capacity temporarily to address the workload’s requirements.`,`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Exceeding capacity limit`}),`: CockroachDB Standard enforces the cluster’s provisioned capacity, limiting application throughput if the workload exceeds the cluster’s provisioned capacity. This can lead to increased query latency and degraded application performance.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Notifications to prevent overrun`}),`: To help mitigate against the risk of exceeding a cluster’s capacity, email and CockroachDB Cloud Console notifications will occur when a cluster workload exceeds 70% and 90% of its provisioned capacity.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Multi-region deployments`}),`: The provisioned capacity of your cluster applies to the entire cluster, regardless of the number of nodes or regional topography. The provisioned capacity is effectively a budget for the cluster that can be used by a node in any region to meet its compute demand. This simplifies planning compute capacity for multi-region deployments. The overall `,_jsx(_components.a,{href:`/docs/cockroachcloud/billing-management`,children:`compute capacity cost`}),` for a multi-region CockroachDB Standard cluster is calculated based on the price of the most expensive region in the cluster.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`After considering the preceding factors, you have enough information to `,_jsx(_components.a,{href:`/docs/cockroachcloud/create-your-cluster`,children:`create a CockroachDB Standard cluster`}),` using the CockroachDB Cloud Console, the `,_jsx(_components.a,{href:`/docs/cockroachcloud/provision-a-cluster-with-terraform`,children:`CockroachDB Terraform provider`}),`, or the `,_jsx(_components.a,{href:`/docs/cockroachcloud/cloud-api`,children:`CockroachDB Cloud API`}),`. After the cluster is deployed, you can `,_jsx(_components.a,{href:`/docs/cockroachcloud/cluster-management#edit-cluster-capacity`,children:`scale its compute capacity`}),` by increasing or decreasing its provisioned capacity as needed.`]}),`\n`,_jsx(Tip,{children:_jsx(_components.p,{children:`You can decrease the provisioned capacity only three times within a 7-day period. You can increase the provisioned capacity at any time.`})}),`\n`,_jsx(_components.p,{children:`The CockroachDB Cloud Console provides insight into your cluster’s compute usage relative to its provisioned capacity on a monthly basis. We recommend that you maintain at minimum a 40% capacity buffer over time, and that you increase this buffer if the workload is unpredictable or highly sensitive to query latency. You now have the advantage of historical data about the cluster’s performance to help you maintain and improve the cluster’s performance over time.`}),`\n`,_jsx(Heading,{level:`3`,id:`recommended-provisioned-capacity-when-changing-cluster-plan`,children:`Recommended provisioned capacity when changing cluster plan`}),`\n`,_jsxs(_components.p,{children:[`If you change your cluster’s plan from Basic to Standard, the Cloud Console will provide a suggested provisioned capacity. This is calculated based on your `,_jsx(_components.a,{href:`/docs/cockroachcloud/plan-your-cluster-basic`,children:`peak request units (RU/sec)`}),` in the last 30 days on the Basic cluster plan. The vCPU suggestion is based on the 30-day peak RU/sec with an additional 40% buffer. 500 RU/sec equates to 1 vCPU. There is a 10-minute roll-up period for the peak RU/sec. If the estimate is beyond the Standard plan’s maximum supported vCPU, you may experience performance issues if your cluster’s workload consistently spikes above that level.`]}),`\n`,_jsx(Heading,{level:`3`,id:`capacity-pricing-policies`,children:`Capacity pricing policies`}),`\n`,_jsx(_components.p,{children:`Important capacity and pricing policies mentioned elsewhere are summarized here:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Minimum and maximum provisioned capacity`}),`: A CockroachDB Standard cluster must have a provisioned capacity of at minimum 2 vCPUs. For production workloads, we recommend at minimum 4 to 8 vCPUs. The maximum capacity for CockroachDB Standard is 200 vCPUs. To express interest in higher-capacity clusters, `,_jsx(_components.a,{href:`https://www.cockroachlabs.com/contact`,children:`talk to an expert`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Enforcing provisioned capacity limits`}),`: CockroachDB Cloud enforces the cluster’s provisioned capacity, limiting application throughput if the workload exceeds the capacity limit. This can result in degraded performance and increased query latency. You can increase a cluster’s capacity at any time.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Capacity for multi-region clusters`}),`: A multi-region cluster’s capacity is available to all cluster nodes in all regions, but is not pre-allocated per region. The cluster’s CPU utilization across regions cannot exceed its provisioned capacity.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Multi-region pricing by the most expensive region`}),`: The overall `,_jsx(_components.a,{href:`/docs/cockroachcloud/billing-management`,children:`compute capacity cost`}),` for a multi-region CockroachDB Standard cluster is calculated based on the price of the most expensive region in the cluster.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Limitations on capacity scaling`}),`: You can decrease the provisioned capacity only three times within a 7-day period. You can increase the provisioned capacity at any time.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`more-details-about-capacity`,children:`More details about capacity`}),`\n`,_jsxs(_components.p,{children:[`We recommend that you start with `,_jsx(_components.a,{href:`#quickstart-provision-and-adjust-capacity`,children:`Quickstart: Provision and adjust capacity`}),` to arrive at the best initial compute capacity for your workload and that you adjust the cluster’s capacity over time as the workload evolves. In addition, consider the following:`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Smaller workloads`}),`: CockroachDB Standard is well suited for workloads that require 12 or fewer vCPUs. By contrast, 12 vCPUs (3 nodes x 4 vCPUs) is the minimum configuration for CockroachDB Advanced.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`CockroachDB Standard is not recommended for:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`Analytical workloads that involve many large, complex reads`})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsx(_components.p,{children:_jsx(_components.strong,{children:`OLAP or hybrid OLTP/OLAP applications`})}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Asymmetric multi-region workloads`}),`: Often, multi-region deployments are asymmetric in terms of CPU utilization across regions. For example, in a three-region cluster, two of the three regions may require more capacity than the third, or vice versa. In CockroachDB Standard, a cluster’s compute capacity is available in all regions.`]}),`\n`,_jsx(_components.p,{children:`For workloads that require asymmetric capacity per region or where a given region must maintain a given compute capacity, CockroachDB Advanced may be a better option.`}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Workloads that are sensitive to latency`}),`: CockroachDB Standard clusters use a different networking architecture than CockroachDB Advanced. This architecture can introduce additional query latency of around 1 microsecond when compared with CockroachDB Advanced.`]}),`\n`]}),`\n`,_jsxs(_components.li,{children:[`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Workloads with advanced security or compliance requirements`}),`: For workloads subject to advanced security or compliance requirements, consider CockroachDB Advanced, which complies with `,_jsx(_components.a,{href:`/docs/cockroachcloud/pci-dss`,children:`PCI DSS and HIPAA`}),`. To learn more refer to `,_jsx(_components.a,{href:`/docs/cockroachcloud/compliance`,children:`Compliance in CockroachDB Cloud`}),`.`]}),`\n`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`For more details to help you compare CockroachDB Cloud cluster plans, refer to `,_jsx(_components.a,{href:`/docs/cockroachcloud/index`,children:`CockroachDB Cloud Overview`}),`.`]}),`\n`,_jsx(Heading,{level:`2`,id:`storage-pricing`,children:`Storage pricing`}),`\n`,_jsxs(_components.p,{children:[`Storage capacity for a CockroachDB Standard cluster is `,_jsx(_components.a,{href:`/docs/cockroachcloud/billing-management`,children:`priced`}),` on demand in units of GiB-month. Storage prices vary across providers and `,_jsx(_components.a,{href:`/docs/cockroachcloud/regions`,children:`regions`}),`. Storage is charged based on the logical amount of data in the database.`]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`3 replicas included`}),`: CockroachDB Standard maintains at minimum three replicas of your data at no additional cost.`]}),`\n`]}),`\n`,_jsx(_components.p,{children:`For a cluster with more than three replicas, storage for each additional replica is priced at the storage price for the region.`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Multi-region storage`}),`: In a multi-region cluster, storage prices vary by region. The data in each region is priced at that region’s storage rate.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`single-region-example`,children:`Single-region example`}),`\n`,_jsx(_components.p,{children:`By default, CockroachDB Cloud maintains three replicas for a single-region cluster, spread across three different availability zones within the region. You are not charged to store these replicas.`}),`\n`,_jsxs(_components.p,{children:[`For example, if a single-region cluster is deployed in `,_jsx(_components.code,{children:`us-central-1`}),` and contains 500 GiB of data. CockroachDB Cloud stores three replicas, for a total of 1500 GiB of data. However, you are billed only for 500 GiB of storage.`]}),`\n`,_jsx(_components.p,{children:`If you add a fourth replica, the cluster consumes 2000 GiB of storage (500 x 4), but you are billed only for 1000 GiB (500 for the data and 500 for the fourth replica).`}),`\n`,_jsx(Heading,{level:`3`,id:`multi-region-example`,children:`Multi-region example`}),`\n`,_jsx(_components.p,{children:`For multi-region clusters, we recommend that 5 or more replicas are maintained across availability zones and regions for resilience against both zone and region failure. The first three replicas are included in the base storage price, while additional replicas are priced based on the ratio of additional regions to the initial three.`}),`\n`,_jsxs(_components.p,{children:[`Consider the example of a three-region cluster with 500 GiB of logical data, deployed in `,_jsx(_components.code,{children:`us-central1`}),`, `,_jsx(_components.code,{children:`us-west2`}),`, and `,_jsx(_components.code,{children:`europe-west1`}),`, with 5 replicas. The logical data and the first three replicas are included in the monthly storage cost. The additional two replicas are charged at 2/3 of the monthly storage cost. This cluster consumes 2500 GiB of storage, but is billed for 1500 GiB for the initial data and 3 replicas, plus 2/3 of the additional 1000 GiB for the additional two replicas (2 replicas beyond the initial 3).`]}),`\n`,_jsx(_components.p,{children:`If you add a 6th replica, the cluster will consume 3000 GiB (500 x 6), and will be billed for 1500 GiB for the initial data and 3 replicas, plus 100% (3/3) of the additional three replicas (3 replicas beyond the initial 3).`}),`\n`,_jsx(Heading,{level:`2`,id:`see-also`,children:`See also`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/docs/cockroachcloud/create-your-cluster`,children:`Create a CockroachDB Standard cluster`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/docs/cockroachcloud/cluster-management#edit-cluster-capacity`,children:`Edit cluster capacity`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/docs/cockroachcloud/plan-your-cluster-advanced`,children:`Plan an CockroachDB Advanced cluster`})}),`\n`,_jsx(_components.li,{children:_jsx(_components.a,{href:`/docs/cockroachcloud/plan-your-cluster-basic`,children:`Plan an CockroachDB Basic cluster`})}),`\n`]})]})}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":"Plan a CockroachDB Standard Cluster","old_description":"Plan your cluster's configuration.","description":null,"href":"/docs/cockroachcloud/plan-your-cluster"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Provisioned capacity","slug":"provisioned-capacity","depth":2,"children":[{"title":"Quickstart: Provision and adjust capacity","slug":"quickstart-provision-and-adjust-capacity","depth":3,"children":[]},{"title":"Recommended provisioned capacity when changing cluster plan","slug":"recommended-provisioned-capacity-when-changing-cluster-plan","depth":3,"children":[]},{"title":"Capacity pricing policies","slug":"capacity-pricing-policies","depth":3,"children":[]},{"title":"More details about capacity","slug":"more-details-about-capacity","depth":3,"children":[]}]},{"title":"Storage pricing","slug":"storage-pricing","depth":2,"children":[{"title":"Single-region example","slug":"single-region-example","depth":3,"children":[]},{"title":"Multi-region example","slug":"multi-region-example","depth":3,"children":[]}]},{"title":"See also","slug":"see-also","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":["/_mintlify/custom/cockroachlabs/4695317e415d4eba/kapa.js","/_mintlify/custom/cockroachlabs/40fb45a3cfe42c92/copy-code-prompt.js","/_mintlify/custom/cockroachlabs/3f343c9e8c40397a/collapse-nav.js"],"subdomain":"cockroachlabs","siteName":"CockroachDB","title":"Plan a CockroachDB Standard Cluster - CockroachDB","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-11T19:17:26.015Z","originalFileLocation":"docs/cockroachcloud/plan-your-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=\"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=\"Plan a CockroachDB Standard Cluster - CockroachDB\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"CockroachDB\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://cockroachlabs.mintlify.site/_mintlify/api/og/v2?division=Standard+Deployments\u0026amp;title=Plan+a+CockroachDB+Standard+Cluster\u0026amp;theme=4aeed7318cb28bd50868adb3\u0026amp;signature=b88ac0f9456985b6231e5e7f36349764b0dcc62a3674707fca054a736b878beb\">\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=\"Plan a CockroachDB Standard Cluster - CockroachDB\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://cockroachlabs.mintlify.site/_mintlify/api/og/v2?division=Standard+Deployments\u0026amp;title=Plan+a+CockroachDB+Standard+Cluster\u0026amp;theme=4aeed7318cb28bd50868adb3\u0026amp;signature=b88ac0f9456985b6231e5e7f36349764b0dcc62a3674707fca054a736b878beb\">\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/cockroachcloud/plan-your-cluster\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/docs/cockroachcloud/plan-your-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/cockroachcloud/plan-your-cluster#webpage\",\"url\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster\",\"name\":\"Plan a CockroachDB Standard Cluster\",\"dateModified\":\"2026-11-11T19:17:26.015Z\",\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"CockroachDB\",\"item\":\"https://docs.cockroachlabs.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Plan a CockroachDB Standard Cluster\",\"item\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#article\",\"headline\":\"Plan a CockroachDB Standard Cluster\",\"name\":\"Plan a CockroachDB Standard Cluster\",\"url\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster\",\"mainEntityOfPage\":{\"@id\":\"https://docs.cockroachlabs.com/docs/cockroachcloud/plan-your-cluster#webpage\"},\"dateModified\":\"2026-11-11T19:17:26.015Z\",\"publisher\":{\"@id\":\"https://docs.cockroachlabs.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.cockroachlabs.com#website\"}}]}\u003c/script>","agentPointerHref":"/docs/cockroachcloud/plan-your-cluster.md","siteName":"CockroachDB","nav":{"global":{"anchors":[{"anchor":"University","icon":"graduation-cap","href":"https://learn.cockroachlabs.com/"}]},"products":[{"product":"Cockroach Continuum Cloud","icon":"https://mintlify.s3.us-west-1.amazonaws.com/cockroachlabs/images/continuum/cockroachlabs-symbol.svg","description":"The agentic database cloud","pages":[{"title":"Cockroach Continuum Cloud","href":"/docs/continuum"}]},{"product":"CockroachDB","icon":"database","description":"Distributed SQL database","versions":[{"version":"v26.4"},{"version":"v26.3"},{"version":"v26.2"},{"version":"v26.1"},{"version":"v25.4"},{"version":"v25.3"},{"version":"v25.2"},{"version":"v25.1"},{"version":"v24.3"},{"version":"v24.1"},{"version":"v23.2"},{"version":"v23.1"}],"pages":[{"title":"CockroachDB","href":"/docs/stable"}]},{"product":"Cloud Deployments","icon":"cloud","description":"Fully managed CockroachDB","tabs":[{"tab":"Deploy","icon":"rocket","groups":[{"group":"Get Started","pages":[{"title":"CockroachDB Cloud Overview","href":"/docs/cockroachcloud"},{"title":"Try CockroachDB Cloud for free","href":"/docs/cockroachcloud/free-trial"},{"title":"Quickstart with CockroachDB","href":"/docs/cockroachcloud/quickstart"},{"title":"Quickstart with CockroachDB Advanced","href":"/docs/cockroachcloud/quickstart-trial-cluster"},{"title":"Create a CockroachDB Cloud account","href":"/docs/cockroachcloud/create-an-account"},{"title":"Understand CockroachDB Cloud Costs","href":"/docs/cockroachcloud/costs"},{"title":"CockroachDB Cloud Regions","href":"/docs/cockroachcloud/regions"}]},{"group":"Basic Deployments","pages":[{"title":"Plan a CockroachDB Basic Cluster","href":"/docs/cockroachcloud/plan-your-cluster-basic"},{"title":"Create a CockroachDB Basic Cluster","href":"/docs/cockroachcloud/create-a-basic-cluster"},{"title":"Connect to a CockroachDB Basic Cluster","href":"/docs/cockroachcloud/connect-to-a-basic-cluster"},{"title":"Understand the Resource Usage of your CockroachDB Basic Cluster","href":"/docs/cockroachcloud/resource-usage-basic"},{"title":"Manage a CockroachDB Basic Cluster","href":"/docs/cockroachcloud/basic-cluster-management"},{"title":"Provision a CockroachDB Cloud Basic cluster with the Terraform provider","href":"/docs/cockroachcloud/provision-a-cluster-with-terraform-basic"},{"title":"Change a Cluster's Plan Between Basic and Standard","description":null,"href":"/docs/cockroachcloud/change-plan-between-basic-and-standard"}]},{"group":"Standard Deployments","pages":[{"title":"Plan a CockroachDB Standard Cluster","href":"/docs/cockroachcloud/plan-your-cluster"},{"title":"Create a CockroachDB Standard Cluster","description":null,"href":"/docs/cockroachcloud/create-your-cluster"},{"title":"Connect to a CockroachDB Standard Cluster","href":"/docs/cockroachcloud/connect-to-your-cluster"},{"title":"Understand the Resource Usage of your CockroachDB Standard Cluster","href":"/docs/cockroachcloud/resource-usage"},{"title":"Manage a CockroachDB Standard Cluster","href":"/docs/cockroachcloud/cluster-management"},{"title":"Provision a CockroachDB Cloud Standard cluster with the Terraform provider","href":"/docs/cockroachcloud/provision-a-cluster-with-terraform"},{"title":"Production Checklist","href":"/docs/cockroachcloud/production-checklist"},{"title":"Migrate from Standard or Basic to Advanced","href":"/docs/cockroachcloud/migrate-from-standard-to-advanced"}]},{"group":"Advanced Deployments","pages":[{"title":"Plan a CockroachDB Advanced Cluster","href":"/docs/cockroachcloud/plan-your-cluster-advanced"},{"title":"Create a CockroachDB Advanced Cluster","href":"/docs/cockroachcloud/create-an-advanced-cluster"},{"title":"Connect to a CockroachDB Advanced Cluster","href":"/docs/cockroachcloud/connect-to-an-advanced-cluster"},{"title":"Manage a CockroachDB Advanced Cluster","href":"/docs/cockroachcloud/advanced-cluster-management"},{"title":"Provision a CockroachDB Cloud Advanced cluster with the Terraform provider","href":"/docs/cockroachcloud/provision-a-cluster-with-terraform-advanced"},{"title":"CockroachDB Advanced on Azure","href":"/docs/cockroachcloud/cockroachdb-advanced-on-azure"}]},{"group":"BYOC Deployments","pages":[{"title":"CockroachDB BYOC Overview","href":"/docs/cockroachcloud/byoc-overview"},{"title":"BYOC Architecture and Data Flow","href":"/docs/cockroachcloud/byoc-architecture"},{"title":"Security and Compliance in BYOC","href":"/docs/cockroachcloud/byoc-security"},{"title":"Prepare a CockroachDB Cloud BYOC Deployment in Amazon Web Services","href":"/docs/cockroachcloud/byoc-aws-deployment"},{"title":"Prepare a CockroachDB Cloud BYOC Deployment in Azure","href":"/docs/cockroachcloud/byoc-azure-deployment"},{"title":"Prepare a CockroachDB Cloud BYOC Deployment in Google Cloud Platform","href":"/docs/cockroachcloud/byoc-gcp-deployment"},{"title":"CockroachDB Cloud BYOC FAQ","href":"/docs/cockroachcloud/byoc-faq"}]},{"group":"Troubleshooting","pages":[{"title":"Troubleshoot Cloud Setup","href":"/docs/cockroachcloud/troubleshooting-page"}]}]},{"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.","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","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"}]}]},"basePath":"","title":"Plan a CockroachDB Standard Cluster - CockroachDB","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":[],"chunks":[]}