Clusters
Delete Cluster
Deletes an existing cluster.
In order to access this endpoint, the provided API key must have at least one of the following roles:
- Organization Owner
- Project Owner
- Project Manager
To learn more, see Organization, Project, and Database Access Overview.
delete/v4/organizations/{organizationId}/projects/{projectId}/clusters/{clusterId}
Request
- Base URLhttps://cloudapi.cloud.couchbase.com
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Query parameters
retainsnapshotbackupsboolean
Example:true
Retain snapshot backups parameter specifies whether to retain snapshot backups after cluster deletion.
Response
Successfully deleted the cluster by its clusterId.
Changes
No recorded changes to this operation across all 5 revisions of this API.