Read the playground provisioning status

Reads the provisioning phase of the organisation’s playground. A playground belonging to another organisation is not found.

GET /org/clusters/playground/{clusterId}/status

Read the playground provisioning status

Python

import requests

url = "https://api.platform.ankra.app/org/clusters/playground/{clusterId}/status"

headers = {"cookie": "ankra_session="}

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

print(response.text)

200

{
  "cluster_id": "<string>",
  "phase": "pending",
  "expires_at": "2023-11-07T05:31:56Z",
  "provider": "hosts",
  "is_trial": true,
  "status_message": "<string>",
  "starter_url": "<string>",
  "trial_expires_at": "2023-11-07T05:31:56Z",
  "public_domain": "<string>",
  "ingress_class": "<string>",
  "ingress_tls_issuer": "<string>",
  "public_ipv4": true,
  "public_ipv4_address": "<string>",
  "public_ipv4_failure": "<string>",
  "plan_change": {
    "desired_plan": "<string>",
    "requested_at": "2023-11-07T05:31:56Z",
    "failure": "<string>",
    "message": "<string>"
  }
}

Authorizations

ankra_session · string · cookie · required

Browser session. Mutations also require X-Ankra-CSRF.

Path Parameters

clusterId · string<uuid> · required

Response

200

application/json

Successful response

cluster_id · string · required

phase · enum<string> · required

Available options: pending, provisioning, agent_installing, ready, failed, deprovisioning, removed

expires_at · string<date-time> · required

provider · enum<string> · required

Where the playground runs: a vcluster on the platform's playground hosts, or an Ankra Cloud dev cluster.

Available options: hosts, ankracloud

is_trial · boolean · required

An Ankra Cloud trial dev cluster: free, and deleted by Ankra Cloud at trial_expires_at unless a payment method is saved first. Always false for hosts playgrounds.

status_message · string | null

starter_url · string | null

trial_expires_at · string<date-time> | null

public_domain · string | null

The cluster's public domain once its DNS zone is usable; null otherwise and for hosts playgrounds.

ingress_class · string | null

The ingress class an application published under public_domain is served with (k3s's bundled Traefik), set together with public_domain on an Ankra Cloud playground; null otherwise.

ingress_tls_issuer · string | null

The cert-manager ClusterIssuer that issues certificates for hostnames under public_domain (letsencrypt-prod, HTTP-01 on ingress_class) on an Ankra Cloud playground, once the platform has installed it there; null before then and otherwise.

public_ipv4 · boolean | null

Whether an Ankra Cloud playground has the public IPv4 add-on, so what it serves answers IPv4 clients too: ordered at create by an account that can spend, or added in place once a trial converts. Null for hosts playgrounds.

public_ipv4_address · string | null

The Ankra Cloud playground's public IPv4 address once it is recorded; null otherwise.

public_ipv4_failure · string | null

Why the public IPv4 add-on could not be added to a converted trial (for example the account's credit does not cover its monthly price); null while the playground has the add-on or nothing failed.

plan_change · object | null

An Ankra Cloud playground's size change: under way (desired_plan, requested_at) while Ankra Cloud restarts the server on the new plan, or the last one that did not take (failure), with a sentence saying which. Null when neither, and for hosts playgrounds.

Show child attributes