Clusters
Delete a cluster
delete/organization/{organizationId}/cluster/{clusterId}
Request
- Base URLhttps://api.qovery.com
- Auth
- API key in header Authorization
- or HTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
organizationIdstring uuid required
Organization ID
clusterIdstring uuid required
Cluster ID
Query parameters
deleteMode'DEFAULT' | 'DELETE_CLUSTER_AND_QOVERY_CONFIG' | 'DELETE_QOVERY_CONFIG'
Indicates the mode to apply on cluster deletion
"hard delete" means that we delete directly from our database, this is different from a "trigger delete" that cleans the resource
- DEFAULT: this is the normal way, trigger delete the cluster only if no environment linked to this cluster remains
- DELETE_CLUSTER_AND_QOVERY_CONFIG: hard delete environments linked to this cluster then trigger delete the cluster
- DELETE_QOVERY_CONFIG: ⚠️ ⚠️ ⚠️ hard delete environments linked to this cluster then hard delete the cluster - whole cluster ressources are not deleted on our side and must be deleted on your side
Example:DEFAULT
Response
The resource was deleted successfully
Changes
No recorded changes to this operation across all 1 revision of this API.