Home Original page

Scaleway Kubernetes API

Introduction

Clusters

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

GET
/k8s/v1/regions/{region}/clusters
POST
/k8s/v1/regions/{region}/clusters
GET
/k8s/v1/regions/{region}/clusters/{cluster_id}
PATCH
/k8s/v1/regions/{region}/clusters/{cluster_id}
DELETE
/k8s/v1/regions/{region}/clusters/{cluster_id}
GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/available-types
GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/available-versions
GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/kubeconfig
POST
/k8s/v1/regions/{region}/clusters/{cluster_id}/reset-admin-token
POST
/k8s/v1/regions/{region}/clusters/{cluster_id}/set-type
POST
/k8s/v1/regions/{region}/clusters/{cluster_id}/upgrade

Pools

A pool is a set of identical nodes A pool has a name, a size (its desired number of nodes), node number limits (min, max), and a Scaleway Instance type. Changing those limits increases/decreases the size of a pool. As a result and depending on its load, the pool will grow or shrink within those limits when autoscaling is enabled.

GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/pools
POST
/k8s/v1/regions/{region}/clusters/{cluster_id}/pools
GET
/k8s/v1/regions/{region}/pools/{pool_id}
PATCH
/k8s/v1/regions/{region}/pools/{pool_id}
DELETE
/k8s/v1/regions/{region}/pools/{pool_id}
POST
/k8s/v1/regions/{region}/pools/{pool_id}/upgrade

Nodes

A node (short for worker node) is an abstraction for a Scaleway Instance A node is always part of a pool. Each of them has the Kubernetes software automatically installed and configured by Scaleway.

GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/nodes
GET
/k8s/v1/regions/{region}/nodes/{node_id}
DELETE
/k8s/v1/regions/{region}/nodes/{node_id}
POST
/k8s/v1/regions/{region}/nodes/{node_id}/reboot
POST
/k8s/v1/regions/{region}/pools/{pool_id}/external-nodes

Versions

A version is a vanilla Kubernetes version like x.y.z It comprises a major version x, a minor version y, and a patch version z. At the minimum, Kapsule (Scaleway's managed Kubernetes), will support the last patch version for the past three minor releases. Also, each version has a different set of CNIs, eventually container runtimes, feature gates, and admission plugins available. See our Version Support Policy.

GET
/k8s/v1/regions/{region}/versions
GET
/k8s/v1/regions/{region}/versions/{version_name}

Cluster types

All cluster types available in a specified region A cluster type represents the different commercial types of clusters offered by Scaleway.

GET
/k8s/v1/regions/{region}/cluster-types

Access Control List

Network Access Control Lists (ACLs) allow you to manage inbound network traffic by setting up ACL rules

DELETE
/k8s/v1/regions/{region}/acls/{acl_id}
GET
/k8s/v1/regions/{region}/clusters/{cluster_id}/acls
POST
/k8s/v1/regions/{region}/clusters/{cluster_id}/acls
PUT
/k8s/v1/regions/{region}/clusters/{cluster_id}/acls