v1

latestOpenAPI 3.0.0Apache 2.02026-07-17143274803.9 KB
clustergroup deployments

Delete Cluster Group Deployment

deletes a cluster group deployment, also deleting deployments from member clusters

delete/api/v1/orgs/{orgid}/clustergroups/{clusterGroupId}/deployments/{deploymentName}

Path parameters

orgIdinteger required

Organization identifier

clusterGroupIdinteger required

Cluster Group ID

deploymentNamestring required

release name of a cluster group deployment

Query parameters

forceboolean

if true cluster group deployment gets deleted even if some deployments can not be deleted from each target cluster

Response

Multi-cluster deployment has been deleted successfully. All delete operations on all targeted clusters returned with no errors.

cloudstring
clusterIdinteger
clusterNamestring
distributionstring
errorstring
staleboolean
statusstring
versionstring

Example response

{
  "cloud": "cloud",
  "stale": true,
  "clusterName": "clusterName",
  "clusterId": 0,
  "distribution": "distribution",
  "error": "error",
  "version": "version",
  "status": "status"
}