Skip to main content
POST
Stop a cluster

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Headers

x-ankra-organisation-id
string

PAT organisation override.

Path Parameters

cluster_id
string<uuid>
required

Query Parameters

force
string | null

Response

Successful response

cluster_id
string<uuid>
required
operation_id
string<uuid> | null
required
success
boolean
required
kept_volumes
object[]

The volumes the cluster's retention_policy leaves at the provider, where they keep billing. Left out when the delete keeps none.

warning
string

Says the kept_volumes stay and keep billing until they are deleted. Left out when the delete keeps none.