Skip to main content
POST
/
api
/
v1
/
clusters
/
upcloud
/
{cluster_id}
/
stop
Stop an UpCloud cluster
import requests

url = "https://platform.ankra.app/api/v1/clusters/upcloud/{cluster_id}/stop"

headers = {"Authorization": "Bearer <token>"}

response = requests.post(url, headers=headers)

print(response.text)
{
  "cluster_id": "<string>",
  "success": true,
  "operation_id": "<string>"
}

Authorizations

​
Authorization
string
header
required

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

Headers

​
authorization
string | null
​
x-ankra-organisation-id
string | null

Path Parameters

​
cluster_id
string<uuid>
required

Query Parameters

​
force
string | null

Response

Cluster stop initiated successfully

​
cluster_id
string<uuid4>
required
​
success
boolean
default:true
​
operation_id
string<uuid4> | null