Skip to navigation

Delete a cluster by id.

View as Markdown

Use to delete a cluster by Universally Unique Identifier (UUID). Will return 202 for success if this api was called on a cluster that its version is >=2.20, and force query param is false or not provided. Will return 204 for success if force query param is true, or if cluster is in a version < 2.20

Authentication

AuthorizationBearer
Bearer authentication

Path parameters

clusterUuidstringRequiredformat: "uuid">=1 character

The Universally Unique Identifier (UUID) of the cluster.

Query parameters

forcebooleanOptionalDefaults to false
if true will force cluster instant deletion otherwise will start cluster graceful deletion process.

Response

Accepted.
codeinteger100-599
messagestring

Errors

401
Unauthorized Error
403
Forbidden Error
500
Internal Server Error
503
Service Unavailable Error