Skip to main content
POST
Preflight a Scaleway Instances cluster

Authorizations

Authorization
string
header
required

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

Headers

x-ankra-organisation-id
string

PAT organisation override.

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>
default:flannel
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
description
string | null
distribution
enum<string>
default:k3s
Available options:
k3s,
kubeadm
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:""
include_dns
boolean
default:true
include_networking
boolean
default:true
kubernetes_version
string | null
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