Create the organisation's playground
import requests
url = "https://platform.ankra.app/api/v1/org/clusters/playground"
payload = {
"plan": "<string>",
"public_ipv4": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({plan: '<string>', public_ipv4: true})
};
fetch('https://platform.ankra.app/api/v1/org/clusters/playground', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/clusters/playground \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": "<string>",
"public_ipv4": true
}
'{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"success": true
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "<string>",
"error_code": "payment_method_required",
"action_url": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}Playground
Create the organisation's playground
Orders the organisation’s playground: a vcluster on Ankra’s shared playground host, or an Ankra Cloud dev cluster on the organisation’s built-in Ankra Cloud credential (the free 24-hour trial without a payment method, a billed dev cluster otherwise; IPv6-only unless public_ipv4 is true). Every body member is optional and an empty body orders the trial size. Requires clusters.write. One live playground per organisation (409 naming it); 402 when a paid size needs a billing plan, card or credit; 403 while the playground feature flag is off; 503 when the host is at capacity.
POST
/
api
/
v1
/
org
/
clusters
/
playground
Create the organisation's playground
import requests
url = "https://platform.ankra.app/api/v1/org/clusters/playground"
payload = {
"plan": "<string>",
"public_ipv4": True
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({plan: '<string>', public_ipv4: true})
};
fetch('https://platform.ankra.app/api/v1/org/clusters/playground', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));curl --request POST \
--url https://platform.ankra.app/api/v1/org/clusters/playground \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"plan": "<string>",
"public_ipv4": true
}
'{
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"cluster_name": "<string>",
"success": true
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}{
"detail": "<string>",
"error_code": "payment_method_required",
"action_url": "<string>"
}{
"detail": "Cluster not found"
}{
"detail": "<string>",
"cluster_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>"
}
]
}{
"detail": "Cluster not found"
}{
"detail": "Cluster not found"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json