Clusters

Download schema

A cluster is a fully managed Kubernetes cluster It is composed of different pools, each pool containing the same kind of nodes.

List Clusters

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters

List all existing Kubernetes clusters in a specific region.

List Clusters › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

List Clusters › query Parameters

organization_id

string

Organization ID on which to filter the returned clusters.

project_id

string

Project ID on which to filter the returned clusters.

order_by

string · enum

Sort order of returned clusters.

Enum values:

created_at_asc

created_at_desc

updated_at_asc

updated_at_desc

name_asc

name_desc

status_asc

status_desc

Default: created_at_asc

page

integer · int32

Page number to return for clusters, from the paginated results.

page_size

integer · uint32

Maximum number of clusters per page.

name

string

Name to filter on, only clusters containing this substring in their name will be returned.

status

string · enum

Status to filter on, only clusters with this status will be returned.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

type

string

Type to filter on, only clusters with this type will be returned.

private_network_id

string

Private Network ID to filter on, only clusters within this Private Network will be returned.

List Clusters › Responses

200

scaleway.k8s.v1.ListClustersResponse

total_count

integer · uint64

Total number of clusters.

scaleway.k8s.v1.Cluster[]

Paginated returned clusters.

GET/k8s/v1/regions/{region}/clusters

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters"

Example Responses

{
  "total_count": 0,
  "clusters": [
    {
      "id": "id",
      "type": "type",
      "name": "name",
      "status": "unknown",
      "version": "version",
      "region": "region",
      "organization_id": "organization_id",
      "project_id": "project_id",
      "tags": [
        "string"
      ],
      "cni": "unknown_cni",
      "description": "description",
      "cluster_url": "cluster_url",
      "dns_wildcard": "dns_wildcard",
      "created_at": "2022-03-22T12:34:56.123456Z",
      "updated_at": "2022-03-22T12:34:56.123456Z",
      "autoscaler_config": {
        "scale_down_disabled": true,
        "scale_down_delay_after_add": "scale_down_delay_after_add",
        "estimator": "unknown_estimator",
        "expander": "unknown_expander",
        "ignore_daemonsets_utilization": true,
        "balance_similar_node_groups": true,
        "expendable_pods_priority_cutoff": 0,
        "scale_down_unneeded_time": "scale_down_unneeded_time",
        "scale_down_utilization_threshold": 0,
        "max_graceful_termination_sec": 0,
        "skip_nodes_with_local_storage": true,
        "log_level": 0
      },
      "auto_upgrade": {
        "enabled": true,
        "maintenance_window": {
          "start_hour": 0,
          "day": "any"
        }
      },
      "upgrade_available": true,
      "feature_gates": [
        "string"
      ],
      "admission_plugins": [
        "string"
      ],
      "open_id_connect_config": {
        "issuer_url": "issuer_url",
        "client_id": "client_id",
        "username_claim": "username_claim",
        "username_prefix": "username_prefix",
        "groups_claim": [
          "string"
        ],
        "groups_prefix": "groups_prefix",
        "required_claim": [
          "string"
        ]
      },
      "apiserver_cert_sans": [
        "string"
      ],
      "private_network_id": "private_network_id",
      "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
      "acl_available": true,
      "iam_nodes_group_id": "iam_nodes_group_id",
      "pod_cidr": "1.2.3.4/32",
      "service_cidr": "1.2.3.4/32",
      "service_dns_ip": "1.2.3.4"
    }
  ]
}

json

application/json

Create a new Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters

Create a new Kubernetes cluster in a Scaleway region.

Create a new Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

Create a new Cluster › Request Body

name

string · required

Cluster name.

version

string · required

Kubernetes version of the cluster.

cni

string · enum · required

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

project_id

string

Project ID in which the cluster will be created.

type

string

Type of the cluster. See list available cluster types for a list of valid types.

description

string

Cluster description.

tags

string[]

Tags associated with the cluster.

scaleway.k8s.v1.CreateClusterRequest.PoolConfig[]

Pools created along with the cluster.

object

Autoscaler configuration for the cluster. It allows you to set (to an extent) your preferred autoscaler configuration, which is an implementation of the cluster-autoscaler (https://github.com/kubernetes/autoscaler/tree/master/cluster-autoscaler/Open in new context).

object

Auto upgrade configuration of the cluster. This configuration enables to set a specific 2-hour time window in which the cluster can be automatically updated to the latest patch version.

feature_gates

string[]

List of feature gates to enable.

admission_plugins

string[]

List of admission plugins to enable.

object

OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication (cannot be changed later).

pod_cidr

string

Subnet used for the Pod CIDR (cannot be changed later). (IP network)

service_cidr

string

Subnet used for the Service CIDR (cannot be changed later). (IP network)

service_dns_ip

string

IP used for the DNS Service (cannot be changes later). If unset, default to Service CIDR's network + 10. (IPv4 address)

Create a new Cluster › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

POST/k8s/v1/regions/{region}/clusters

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "cni": "unknown_cni",
    "description": "string",
    "name": "string",
    "type": "string",
    "version": "string"
  }' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters"

Example Request Body

{
  "organization_id": "organization_id",
  "project_id": "project_id",
  "type": "type",
  "name": "name",
  "description": "description",
  "tags": [
    "string"
  ],
  "version": "version",
  "cni": "unknown_cni",
  "pools": [
    {
      "name": "name",
      "node_type": "node_type",
      "placement_group_id": "placement_group_id",
      "autoscaling": true,
      "size": 0,
      "min_size": 0,
      "max_size": 0,
      "container_runtime": "unknown_runtime",
      "autohealing": true,
      "tags": [
        "string"
      ],
      "kubelet_args": {
        "<kubelet_argKey>": "<kubelet_argKey>"
      },
      "upgrade_policy": {
        "max_unavailable": 0,
        "max_surge": 0
      },
      "zone": "zone",
      "root_volume_type": "default_volume_type",
      "root_volume_size": 0,
      "public_ip_disabled": true,
      "security_group_id": "security_group_id",
      "labels": {
        "<labelKey>": "<labelKey>"
      },
      "taints": [
        {
          "key": "key",
          "value": "value",
          "effect": "NoSchedule"
        }
      ],
      "startup_taints": [
        {
          "key": "key",
          "value": "value",
          "effect": "NoSchedule"
        }
      ]
    }
  ],
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": {
      "value": 0
    },
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enable": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

Get a Cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}

Retrieve information about a specific Kubernetes cluster.

Get a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

ID of the requested cluster.

Get a Cluster › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

GET/k8s/v1/regions/{region}/clusters/{cluster_id}

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}"

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

Delete a Cluster

DELETE

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}

Delete a specific Kubernetes cluster and all its associated pools and nodes, and possibly its associated Load Balancers or Block Volumes.

Delete a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

ID of the cluster to delete.

Delete a Cluster › query Parameters

with_additional_resources

boolean · required

Defines whether all volumes (including retain volume type), empty Private Networks and Load Balancers with a name starting with the cluster ID will also be deleted.

Delete a Cluster › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

DELETE/k8s/v1/regions/{region}/clusters/{cluster_id}

curl -X DELETE \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}?with_additional_resources=false"

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

Update a Cluster

PATCH

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}

Update information on a specific Kubernetes cluster. You can update details such as its name, description, tags and configuration. To upgrade a cluster, you will need to use the dedicated endpoint.

Update a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

ID of the cluster to update.

Update a Cluster › Request Body

name

string

New external name for the cluster.

description

string

New description for the cluster.

tags

string[]

New tags associated with the cluster.

object

New autoscaler config for the cluster.

object

New auto upgrade configuration for the cluster. Note that all fields needs to be set.

feature_gates

string[]

List of feature gates to enable.

admission_plugins

string[]

List of admission plugins to enable.

object

OpenID Connect configuration of the cluster. This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

Update a Cluster › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

PATCH/k8s/v1/regions/{region}/clusters/{cluster_id}

curl -X PATCH \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}"

Example Request Body

{
  "name": "name",
  "description": "description",
  "tags": [
    "string"
  ],
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": {
      "value": 0
    },
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enable": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ]
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

List available cluster types for a cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/available-types

List the cluster types that a specific Kubernetes cluster is allowed to switch to.

List available cluster types for a cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

Cluster ID for which the available Kubernetes types will be listed.

List available cluster types for a cluster › Responses

200

scaleway.k8s.v1.ListClusterAvailableTypesResponse

scaleway.k8s.v1.ClusterType[]

Available cluster types for the cluster.

total_count

integer · uint64

Total number of types.

List available versions for a Cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/available-versions

List the versions that a specific Kubernetes cluster is allowed to upgrade to. Results will include every patch version greater than the current patch, as well as one minor version ahead of the current version. Any upgrade skipping a minor version will not work.

List available versions for a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

Cluster ID for which the available Kubernetes versions will be listed.

List available versions for a Cluster › Responses

200

scaleway.k8s.v1.ListClusterAvailableVersionsResponse

scaleway.k8s.v1.Version[]

Available Kubernetes versions for the cluster.

GET/k8s/v1/regions/{region}/clusters/{cluster_id}/available-versions

curl -X GET \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}/available-versions"

Example Responses

{
  "versions": [
    {
      "name": "name",
      "label": "label",
      "region": "region",
      "available_cnis": [
        "unknown_cni"
      ],
      "available_container_runtimes": [
        "unknown_runtime"
      ],
      "available_feature_gates": [
        "string"
      ],
      "available_admission_plugins": [
        "string"
      ],
      "available_kubelet_args": {
        "<available_kubelet_argKey>": "<available_kubelet_argKey>"
      },
      "deprecated_at": "2022-03-22T12:34:56.123456Z",
      "end_of_life_at": "2022-03-22T12:34:56.123456Z",
      "released_at": "2022-03-22T12:34:56.123456Z"
    }
  ]
}

json

application/json

Download the kubeconfig for a Cluster

GET

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/kubeconfig

Download the Kubernetes cluster config file (also known as kubeconfig) for a specific cluster to use it with kubectl. Tip: add ?dl=1 at the end of the URL to directly retrieve the base64 decoded kubeconfig. If you choose not to, the kubeconfig will be base64 encoded.

Download the kubeconfig for a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

Cluster ID for which to download the kubeconfig.

Download the kubeconfig for a Cluster › query Parameters

redacted

boolean

Hide the legacy token from the kubeconfig.

Download the kubeconfig for a Cluster › Responses

200

scaleway.std.File

name

string

content_type

string

content

string

Reset the admin token of a Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/reset-admin-token

Reset the admin token for a specific Kubernetes cluster. This will revoke the old admin token (which will not be usable afterwards) and create a new one. Note that you will need to download the kubeconfig again to keep interacting with the cluster.

Reset the admin token of a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

Cluster ID on which the admin token will be renewed.

Reset the admin token of a Cluster › Request Body

Reset the admin token of a Cluster › Responses

No data returned

Change the Cluster type

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/set-type

Change the type of a specific Kubernetes cluster. To see the possible values you can enter for the type field, list available cluster types.

Change the Cluster type › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

ID of the cluster to migrate from one type to another.

Change the Cluster type › Request Body

type

string · required

Type of the cluster. Note that some migrations are not possible (please refer to product documentation).

Change the Cluster type › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

POST/k8s/v1/regions/{region}/clusters/{cluster_id}/set-type

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"type":"string"}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}/set-type"

Example Request Body

{
  "type": "type"
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

Upgrade a Cluster

POST

https://api.scaleway.com

/k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade

Upgrade a specific Kubernetes cluster and possibly its associated pools to a specific and supported Kubernetes version.

Upgrade a Cluster › path Parameters

region

string · enum · required

The region you want to target

Enum values:

fr-par

nl-ams

pl-waw

cluster_id

string · required

ID of the cluster to upgrade.

Upgrade a Cluster › Request Body

version

string · required

New Kubernetes version of the cluster. Note that the version should either be a higher patch version of the same minor version or the direct minor version after the current one.

upgrade_pools

boolean

Defines whether pools will also be upgraded once the control plane is upgraded.

Upgrade a Cluster › Responses

200

scaleway.k8s.v1.Cluster

id

string

Cluster ID.

type

string

Cluster type.

name

string

Cluster name.

status

string · enum

Status of the cluster.

Enum values:

unknown

creating

ready

deleting

deleted

updating

locked

pool_required

Default: unknown

version

string

Kubernetes version of the cluster.

region

string

Region in which the cluster is deployed.

organization_id

string

ID of the Organization owning the cluster.

project_id

string

ID of the Project owning the cluster.

tags

string[]

Tags associated with the cluster.

cni

string · enum

Container Network Interface (CNI) plugin running in the cluster.

Enum values:

unknown_cni

cilium

calico

weave

flannel

kilo

none

cilium_native

Default: unknown_cni

description

string

Cluster description.

cluster_url

string

Kubernetes API server URL of the cluster.

dns_wildcard

string

Wildcard DNS resolving all the ready cluster nodes.

created_at

string · date-time

Date on which the cluster was created. (RFC 3339 format)

updated_at

string · date-time

Date on which the cluster was last updated. (RFC 3339 format)

object

Autoscaler configuration for the cluster, see https://github.com/kubernetes/autoscaler/blob/master/cluster-autoscaler/FAQ.mdOpen in new context for details.

object

Auto upgrade Kubernetes version of the cluster.

upgrade_available

boolean

Defines whether a new Kubernetes version is available.

feature_gates

string[]

List of enabled feature gates.

admission_plugins

string[]

List of enabled admission plugins.

object

This configuration enables to update the OpenID Connect configuration of the Kubernetes API server.

apiserver_cert_sans

string[]

Additional Subject Alternative Names for the Kubernetes API server certificate.

private_network_id

string

Private network ID for internal cluster communication.

commitment_ends_at

string · date-time

Date on which it will be possible to switch to a smaller offer. (RFC 3339 format)

iam_nodes_group_id

string

IAM group that nodes are members of (this field might be empty during early stage of cluster creation).

pod_cidr

string

Subnet used for the Pod CIDR. (IP network)

service_cidr

string

Subnet used for the Service CIDR. (IP network)

service_dns_ip

string

IP used for the DNS Service. (IPv4 address)

POST/k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade

curl -X POST \
  -H "X-Auth-Token: $SCW_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -d '{"upgrade_pools":false,"version":"string"}' \
  "https://api.scaleway.com/k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade"

Example Request Body

{
  "version": "version",
  "upgrade_pools": true
}

json

Example Responses

{
  "id": "id",
  "type": "type",
  "name": "name",
  "status": "unknown",
  "version": "version",
  "region": "region",
  "organization_id": "organization_id",
  "project_id": "project_id",
  "tags": [
    "string"
  ],
  "cni": "unknown_cni",
  "description": "description",
  "cluster_url": "cluster_url",
  "dns_wildcard": "dns_wildcard",
  "created_at": "2022-03-22T12:34:56.123456Z",
  "updated_at": "2022-03-22T12:34:56.123456Z",
  "autoscaler_config": {
    "scale_down_disabled": true,
    "scale_down_delay_after_add": "scale_down_delay_after_add",
    "estimator": "unknown_estimator",
    "expander": "unknown_expander",
    "ignore_daemonsets_utilization": true,
    "balance_similar_node_groups": true,
    "expendable_pods_priority_cutoff": 0,
    "scale_down_unneeded_time": "scale_down_unneeded_time",
    "scale_down_utilization_threshold": 0,
    "max_graceful_termination_sec": 0,
    "skip_nodes_with_local_storage": true,
    "log_level": 0
  },
  "auto_upgrade": {
    "enabled": true,
    "maintenance_window": {
      "start_hour": 0,
      "day": "any"
    }
  },
  "upgrade_available": true,
  "feature_gates": [
    "string"
  ],
  "admission_plugins": [
    "string"
  ],
  "open_id_connect_config": {
    "issuer_url": "issuer_url",
    "client_id": "client_id",
    "username_claim": "username_claim",
    "username_prefix": "username_prefix",
    "groups_claim": [
      "string"
    ],
    "groups_prefix": "groups_prefix",
    "required_claim": [
      "string"
    ]
  },
  "apiserver_cert_sans": [
    "string"
  ],
  "private_network_id": "private_network_id",
  "commitment_ends_at": "2022-03-22T12:34:56.123456Z",
  "acl_available": true,
  "iam_nodes_group_id": "iam_nodes_group_id",
  "pod_cidr": "1.2.3.4/32",
  "service_cidr": "1.2.3.4/32",
  "service_dns_ip": "1.2.3.4"
}

json

application/json

Pools