Skip to main content
POST
Preflight a managed cluster (browser session)

Authorizations

ankra_session
string
cookie
required

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

Headers

X-Ankra-CSRF
string
required

Must match the ankra_csrf browser cookie.

Path Parameters

provider
enum<string>
required
Available options:
doks,
uks,
gke,
ovh_mks,
aks,
eks,
kapsule,
ankracloud_k8s
Example:

"kapsule"

Body

application/json
credential_id
string<uuid>
required
location
string
required
name
string
required
node_pools
object[]
required
Minimum array length: 1
cluster_plan
string | null
cni
enum<string> | null
Available options:
cilium,
cilium_native,
calico
criticality
enum<string> | null
Available options:
production,
staging,
development,
disposable
description
string | null
eks
object | null
environment
string | null
Required string length: 1 - 50
gitops_branch
string
default:master
gitops_credential_name
string | null
gitops_repository
string | null
gitops_provider
enum<string>
default:github

GitOps provider of the repository the cluster is bootstrapped onto. Omitted is github, where gitops_repository is owner/name. bitbucket_cloud names the repository by gitops_workspace and gitops_repo_slug (or gitops_repository as workspace/repo_slug) and binds it as a Bitbucket Cloud repository.

Available options:
github,
bitbucket_cloud
gitops_workspace
string | null

Bitbucket Cloud workspace of the GitOps repository. Only with gitops_provider bitbucket_cloud; provided together with gitops_repo_slug.

gitops_repo_slug
string | null

Bitbucket Cloud repository slug of the GitOps repository. Only with gitops_provider bitbucket_cloud; provided together with gitops_workspace.

gke
object | null
ha
boolean | null
kapsule
object | null
ankracloud_k8s
object | null

Ankra Cloud Kubernetes networking: an existing private network the nodes join (Ankra creates and owns ankra- otherwise), the RFC 1918 range of that created network, and the IPv4 API endpoint add-on (on unless refused).

kubernetes_version
string | null
aks
object | null

Response

Successful response

can_proceed
boolean
required
items
object[]
required