Skip to main content
POST
Preflight a Scaleway Instances 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.

Body

application/json
credential_id
string<uuid>
required
name
string
required
region
string
required
ssh_key_credential_id
string<uuid>
required
zone
string
required
bastion_port
integer
default:61000

61000, or a port from 1024 through 59999.

cni
enum<string>

Container network. Omitted resolves to cilium on kubeadm (the default distribution) and flannel on k3s.

Available options:
flannel,
calico,
cilium
cni_features
object
control_plane_count
integer
default:1
Required range: 1 <= x <= 9
control_plane_type
string
default:DEV1-M
criticality
enum<string> | null
Available options:
production,
staging,
development,
disposable
description
string | null
distribution
enum<string>
default:kubeadm
Available options:
k3s,
kubeadm
environment
string | null
Required string length: 1 - 50
etcd_node_count
integer
default:3
etcd_topology
enum<string>
default:stacked
Available options:
stacked,
external
etcd_type
string
default:DEV1-M
external_cloud_provider
boolean
default:true
gateway_allowed_ips
string[]
gateway_type
string
default:VPC-GW-S
gitops_branch
string
default:master
gitops_credential_name
string
default:""
gitops_repository
string
default:""
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.

include_dns
boolean
default:true
include_networking
boolean
default:true
kubernetes_version
string | null
k3s_disabled_components
enum<string>[] | null

k3s packaged components to keep disabled (k3s --disable), for example ["traefik"] on a cluster that brings its own ingress. k3s distribution only: the list is rendered into the server config at install and re-asserted by the maintenance pass, so the entries stay off across restarts.

Available options:
coredns,
servicelb,
traefik,
local-storage,
metrics-server,
runtimes
network_ip_range
string | null

CIDR for create-new mode; mutually exclusive with private_network_id.

node_groups
object[] | null
private_network_id
string | null
retention_policy
enum<string>
default:retain
Available options:
delete,
retain
runtime_credential_id
string<uuid> | null
worker_count
integer
default:1
Required range: 0 <= x <= 100
worker_type
string
default:DEV1-M

Response

Successful response

can_proceed
boolean
required
items
object[]
required