Kubernetes

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

network

kubernetesNetwork · minLength: 1 · required

Network UUID

zone

kubernetesZone · minLength: 1 · required

UpCloud zone to provision the Kubernetes cluster in

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

network_cidr

CIDR of the given network

storage_encryption

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

state

kubernetesClusterState · enum

Cluster operational state

Enum values:

failed

pending

running

terminated

terminating

unknown

suspended

upgrading

uuid

kubernetesUuid · uuid

UUID

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

private_node_groups

Enable private node groups

Default: false

GET/1.3/kubernetes

curl https://api.upcloud.com/1.3/kubernetes \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "control_plane_ip_filter": [
      "1.2.3.4/24",
      "1.1.1.1"
    ],
    "name": "example-cluster",
    "network": "33333333-3333-3333-333333333333",
    "network_cidr": "172.16.0.0/24",
    "node_groups": [
      {
        "count": 4,
        "kubelet_args": [
          {
            "key": "log-flush-frequency",
            "value": "5s"
          }
        ],
        "labels": [
          {
            "key": "managedBy",
            "value": "exampleDevelopmentTeam"
          },
          {
            "key": "environment",
            "value": "development"
          }
        ],
        "name": "small",
        "plan": "K8S-2xCPU-4GB",
        "ssh_keys": [
          "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
        ],
        "state": "running",
        "storage": "01000000-0000-4000-8000-000160010100",
        "taints": [
          {
            "effect": "NoSchedule",
            "key": "environment",
            "value": "development"
          }
        ]
      },
      {
        "count": 8,
        "kubelet_args": [
          {
            "key": "log-flush-frequency",
            "value": "15s"
          }
        ],
        "labels": [
          {
            "key": "managedBy",
            "value": "exampleStagingTeam"
          },
          {
            "key": "environment",
            "value": "staging"
          }
        ],
        "name": "medium",
        "plan": "K8S-4xCPU-8GB",
        "ssh_keys": [
          "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
        ],
        "state": "pending",
        "storage": "01000000-0000-4000-8000-000160010100",
        "taints": [
          {
            "effect": "NoSchedule",
            "key": "environment",
            "value": "staging"
          }
        ]
      }
    ],
    "uuid": "11111111-1111-1111-1111-111111111111",
    "state": "running",
    "zone": "de-fra1"
  },
  {
    "name": "another-example-cluster",
    "network": "another33333333-3333-3333-333333333333",
    "network_cidr": "172.16.0.0/24",
    "node_groups": [
      {
        "count": 4,
        "name": "large",
        "plan": "K8S-8xCPU-32GB",
        "ssh_keys": [
          "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
        ],
        "state": "running",
        "storage": "01000000-0000-4000-8000-000160010100"
      }
    ],
    "uuid": "22222222-2222-2222-2222-222222222222",
    "state": "pending",
    "zone": "de-fra1"
  }
]

json

application/json

Create cluster

POST

https://api.upcloud.com

/1.3/kubernetes

Creates a new Kubernetes cluster.

Create cluster › Request Body

Kubernetes cluster

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

network

kubernetesNetwork · minLength: 1 · required

Network UUID

zone

kubernetesZone · minLength: 1 · required

UpCloud zone to provision the Kubernetes cluster in

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

network_cidr

CIDR of the given network

storage_encryption

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

state

kubernetesClusterState · enum

Cluster operational state

Enum values:

failed

pending

running

terminated

terminating

unknown

suspended

upgrading

uuid

kubernetesUuid · uuid

UUID

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

private_node_groups

Enable private node groups

Default: false

Create cluster › Responses

201 postCluster response

Kubernetes cluster

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

network

kubernetesNetwork · minLength: 1 · required

Network UUID

zone

kubernetesZone · minLength: 1 · required

UpCloud zone to provision the Kubernetes cluster in

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

network_cidr

CIDR of the given network

storage_encryption

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

state

kubernetesClusterState · enum

Cluster operational state

Enum values:

failed

pending

running

terminated

terminating

unknown

suspended

upgrading

uuid

kubernetesUuid · uuid

UUID

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

private_node_groups

Enable private node groups

Default: false

POST/1.3/kubernetes

curl https://api.upcloud.com/1.3/kubernetes \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "name": "example-cluster",
  "network": "33333333-3333-3333-333333333333",
  "network_cidr": "172.16.0.0/24",
  "labels": [
    {
      "key": "env",
      "value": "prod"
    },
    {
      "key": "app",
      "value": "cats-dating-app"
    }
  ],
  "node_groups": [
    {
      "count": 4,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "5s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleDevelopmentTeam"
        },
        {
          "key": "environment",
          "value": "development"
        }
      ],
      "name": "small",
      "plan": "K8S-2xCPU-4GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "development"
        }
      ]
    },
    {
      "count": 8,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "15s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleStagingTeam"
        },
        {
          "key": "environment",
          "value": "staging"
        }
      ],
      "name": "medium",
      "plan": "K8S-4xCPU-8GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "staging"
        }
      ]
    }
  ],
  "zone": "de-fra1"
}'

Example Request Body

{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "name": "example-cluster",
  "network": "33333333-3333-3333-333333333333",
  "network_cidr": "172.16.0.0/24",
  "labels": [
    {
      "key": "env",
      "value": "prod"
    },
    {
      "key": "app",
      "value": "cats-dating-app"
    }
  ],
  "node_groups": [
    {
      "count": 4,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "5s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleDevelopmentTeam"
        },
        {
          "key": "environment",
          "value": "development"
        }
      ],
      "name": "small",
      "plan": "K8S-2xCPU-4GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "development"
        }
      ]
    },
    {
      "count": 8,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "15s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleStagingTeam"
        },
        {
          "key": "environment",
          "value": "staging"
        }
      ],
      "name": "medium",
      "plan": "K8S-4xCPU-8GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "staging"
        }
      ]
    }
  ],
  "zone": "de-fra1"
}

json

application/json

Example Responses

{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "name": "example-cluster",
  "network": "33333333-3333-3333-333333333333",
  "network_cidr": "172.16.0.0/24",
  "node_groups": [
    {
      "count": 4,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "5s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleDevelopmentTeam"
        },
        {
          "key": "environment",
          "value": "development"
        }
      ],
      "name": "example-node-group-small",
      "plan": "K8S-2xCPU-4GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "pending",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "development"
        }
      ]
    },
    {
      "count": 8,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "15s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleStagingTeam"
        },
        {
          "key": "environment",
          "value": "staging"
        }
      ],
      "name": "example-node-group-medium",
      "plan": "K8S-4xCPU-8GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "pending",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "staging"
        }
      ]
    }
  ],
  "uuid": "11111111-1111-1111-1111-111111111111",
  "state": "pending",
  "zone": "de-fra1"
}

json

application/json

Get cluster details

GET

https://api.upcloud.com

/1.3/kubernetes/{uuid}

Returns Kubernetes cluster details by given uuid.

Get cluster details › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Get cluster details › Responses

200 getCluster response

Kubernetes cluster

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

network

kubernetesNetwork · minLength: 1 · required

Network UUID

zone

kubernetesZone · minLength: 1 · required

UpCloud zone to provision the Kubernetes cluster in

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

network_cidr

CIDR of the given network

storage_encryption

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

state

kubernetesClusterState · enum

Cluster operational state

Enum values:

failed

pending

running

terminated

terminating

unknown

suspended

upgrading

uuid

kubernetesUuid · uuid

UUID

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

private_node_groups

Enable private node groups

Default: false

GET/1.3/kubernetes/{uuid}

curl https://api.upcloud.com/1.3/kubernetes/:uuid \
  --header 'Authorization: Bearer <token>'

Example Responses

{
  "control_plane_ip_filter": [
    "1.2.3.4/24",
    "1.1.1.1"
  ],
  "name": "example-cluster",
  "network": "33333333-3333-3333-333333333333",
  "network_cidr": "172.16.0.0/24",
  "node_groups": [
    {
      "count": 4,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "5s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleDevelopmentTeam"
        },
        {
          "key": "environment",
          "value": "development"
        }
      ],
      "name": "small",
      "plan": "K8S-2xCPU-4GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "running",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "development"
        }
      ]
    },
    {
      "count": 8,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "15s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleStagingTeam"
        },
        {
          "key": "environment",
          "value": "staging"
        }
      ],
      "name": "medium",
      "plan": "K8S-4xCPU-8GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "pending",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "staging"
        }
      ]
    }
  ],
  "uuid": "11111111-1111-1111-1111-111111111111",
  "state": "running",
  "zone": "de-fra1"
}

json

application/json

Delete cluster

DELETE

https://api.upcloud.com

/1.3/kubernetes/{uuid}

Deletes an existing Kubernetes cluster by given uuid.

Delete cluster › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Delete cluster › Responses

202 deleteCluster response

Message

kubernetesAccepted

message

kubernetesMessage

Message text content

Modify cluster

PATCH

https://api.upcloud.com

/1.3/kubernetes/{uuid}

Modifies an existing Kubernetes cluster by given {uuid}.

Modify cluster › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Modify cluster › Request Body

kubernetesClusterPatch

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

Modify cluster › Responses

202 patchCluster response

Kubernetes cluster

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

network

kubernetesNetwork · minLength: 1 · required

Network UUID

zone

kubernetesZone · minLength: 1 · required

UpCloud zone to provision the Kubernetes cluster in

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

labels

required

control_plane_ip_filter

kubernetesIPBlock[] · maxItems: 100 · unique

List of IP blocks

network_cidr

CIDR of the given network

storage_encryption

The storage encryption strategy.

Enum values:

data-at-rest

none

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

state

kubernetesClusterState · enum

Cluster operational state

Enum values:

failed

pending

running

terminated

terminating

unknown

suspended

upgrading

uuid

kubernetesUuid · uuid

UUID

plan

kubernetesClusterPlan · enum

Cluster plan

Enum values:

development

production-small

dev-md

prod-md

prod-md-ha

Default: development

private_node_groups

kubernetesClusterKubeconfig

Enable private node groups

Default: false

PATCH/1.3/kubernetes/{uuid}

curl https://api.upcloud.com/1.3/kubernetes/:uuid \
  --request PATCH \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "labels": [
    {
      "key": "env",
      "value": "prod"
    },
    {
      "key": "app",
      "value": "cats-dating-app"
    }
  ]
}'

Example Request Body

{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "labels": [
    {
      "key": "env",
      "value": "prod"
    },
    {
      "key": "app",
      "value": "cats-dating-app"
    }
  ]
}

json

application/json

Example Responses

{
  "control_plane_ip_filter": [
    "1.2.3.0/24",
    "1.1.1.1"
  ],
  "name": "example-cluster",
  "network": "33333333-3333-3333-333333333333",
  "network_cidr": "172.16.0.0/24",
  "node_groups": [
    {
      "count": 4,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "5s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleDevelopmentTeam"
        },
        {
          "key": "environment",
          "value": "development"
        }
      ],
      "name": "example-node-group-small",
      "plan": "K8S-2xCPU-4GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "pending",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "development"
        }
      ]
    },
    {
      "count": 8,
      "kubelet_args": [
        {
          "key": "log-flush-frequency",
          "value": "15s"
        }
      ],
      "labels": [
        {
          "key": "managedBy",
          "value": "exampleStagingTeam"
        },
        {
          "key": "environment",
          "value": "staging"
        }
      ],
      "name": "example-node-group-medium",
      "plan": "K8S-4xCPU-8GB",
      "ssh_keys": [
        "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
      ],
      "state": "running",
      "storage": "01000000-0000-4000-8000-000160010100",
      "taints": [
        {
          "effect": "NoSchedule",
          "key": "environment",
          "value": "staging"
        }
      ]
    }
  ],
  "uuid": "11111111-1111-1111-1111-111111111111",
  "state": "running",
  "zone": "de-fra1"
}

json

application/json

Get kubeconfig

GET

https://api.upcloud.com

/1.3/kubernetes/{uuid}/kubeconfig

Returns kubeconfig for Kubernetes cluster by given {uuid}.

Get kubeconfig › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Get kubeconfig › Responses

200 getClusterKubeconfig response

Kubernetes cluster kubeconfig

kubeconfig

kubernetesKubeconfig · required

Kubeconfig

Get available upgrades

GET

https://api.upcloud.com

/1.3/kubernetes/{uuid}/available-upgrades

Returns a list of available versions that can be used to upgrade the cluster.

Get available upgrades › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Get available upgrades › Responses

200 upgrades response

kubernetesClusterAvailableUpgrades

versions

kubernetesClusterVersion[] · required

Upgrade cluster

POST

https://api.upcloud.com

/1.3/kubernetes/{uuid}/available-upgrades

Upgrades an existing Kubernetes cluster to specific version.

Upgrade cluster › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Upgrade cluster › Request Body

kubernetesClusterAvailableUpgradesPost

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

kubernetesClusterUpgradeStrategy

upgrade strategy for node group upgrades

Upgrade cluster › Responses

200 upgrades response

kubernetesClusterAvailableUpgradesPost

version

kubernetesClusterVersion · required

Kubernetes version identifier

Default: 1.26

kubernetesClusterUpgradeStrategy

upgrade strategy for node group upgrades

List node groups

GET

https://api.upcloud.com

/1.3/kubernetes/{uuid}/node-groups

Returns a list of available node groups of an existing Kubernetes cluster. Cluster is identified by given {uuid}.

A node group is a uniform set of worker nodes attached to a cluster.

List node groups › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

List node groups › Responses

200 getNodeGroups response

kubernetesNodeGroup[] · maxItems: 16 · unique

List of node groups

Node group for a Kubernetes cluster

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

Node group cloud native plan properties

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

List of taints

anti_affinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

Enable periodic package updates on node

GET/1.3/kubernetes/{uuid}/node-groups

curl https://api.upcloud.com/1.3/kubernetes/:uuid/node-groups \
  --header 'Authorization: Bearer <token>'

Example Responses

[
  {
    "count": 4,
    "kubelet_args": [
      {
        "key": "log-flush-frequency",
        "value": "5s"
      }
    ],
    "labels": [
      {
        "key": "managedBy",
        "value": "exampleDevelopmentTeam"
      },
      {
        "key": "environment",
        "value": "development"
      }
    ],
    "name": "small",
    "plan": "K8S-2xCPU-4GB",
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
    ],
    "state": "running",
    "storage": "01000000-0000-4000-8000-000160010100",
    "taints": [
      {
        "effect": "NoSchedule",
        "key": "environment",
        "value": "development"
      }
    ]
  },
  {
    "count": 8,
    "kubelet_args": [
      {
        "key": "log-flush-frequency",
        "value": "15s"
      }
    ],
    "labels": [
      {
        "key": "managedBy",
        "value": "exampleStagingTeam"
      },
      {
        "key": "environment",
        "value": "staging"
      }
    ],
    "name": "medium",
    "plan": "K8S-4xCPU-8GB",
    "ssh_keys": [
      "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
    ],
    "state": "pending",
    "storage": "01000000-0000-4000-8000-000160010100",
    "taints": [
      {
        "effect": "NoSchedule",
        "key": "environment",
        "value": "staging"
      }
    ]
  }
]

json

application/json

Create node group

POST

https://api.upcloud.com

/1.3/kubernetes/{uuid}/node-groups

Creates a new node group to an existing Kubernetes cluster. Cluster is identified by given {uuid}.

Create node group › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

Create node group › Request Body

Node group for a Kubernetes cluster

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

Node group cloud native plan properties

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

List of taints

anti_affinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

Enable periodic package updates on node

Create node group › Responses

201 postNodeGroup response

Node group for a Kubernetes cluster

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

Node group cloud native plan properties

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

List of taints

anti_affinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

kubernetesNodeGroupDetails

Enable periodic package updates on node

POST/1.3/kubernetes/{uuid}/node-groups

curl https://api.upcloud.com/1.3/kubernetes/:uuid/node-groups \
  --request POST \
  --header 'Content-Type: application/json' \
  --header 'Authorization: Bearer <token>' \
  --data '{
  "count": 4,
  "kubelet_args": [
    {
      "key": "log-flush-frequency",
      "value": "5s"
    }
  ],
  "labels": [
    {
      "key": "managedBy",
      "value": "exampleDevelopmentTeam"
    },
    {
      "key": "environment",
      "value": "development"
    }
  ],
  "name": "small",
  "plan": "K8S-2xCPU-4GB",
  "ssh_keys": [
    "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
  ],
  "storage": "01000000-0000-4000-8000-000160010100",
  "taints": [
    {
      "effect": "NoSchedule",
      "key": "environment",
      "value": "development"
    }
  ]
}'

Example Request Body

{
  "count": 4,
  "kubelet_args": [
    {
      "key": "log-flush-frequency",
      "value": "5s"
    }
  ],
  "labels": [
    {
      "key": "managedBy",
      "value": "exampleDevelopmentTeam"
    },
    {
      "key": "environment",
      "value": "development"
    }
  ],
  "name": "small",
  "plan": "K8S-2xCPU-4GB",
  "ssh_keys": [
    "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
  ],
  "storage": "01000000-0000-4000-8000-000160010100",
  "taints": [
    {
      "effect": "NoSchedule",
      "key": "environment",
      "value": "development"
    }
  ]
}

json

application/json

Example Responses

{
  "count": 4,
  "kubelet_args": [
    {
      "key": "log-flush-frequency",
      "value": "5s"
    }
  ],
  "labels": [
    {
      "key": "managedBy",
      "value": "exampleDevelopmentTeam"
    },
    {
      "key": "environment",
      "value": "development"
    }
  ],
  "name": "small",
  "plan": "K8S-2xCPU-4GB",
  "ssh_keys": [
    "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCDxPPyWRTVHYOOaCE/gqDzcdJFZdo1mD8k+BBvZ4an/khT+rzJGT/K1kvxs1vS1AMzaVbuWH1bLVk8XVDVJ3J7Rf76E50O1mj3+SWW81bjneVlAxw7DRoxZInFio7TMFTt6eSRkOGQ2GVpvkePgunVZsk+XE13fSnthqS1TiiivnmaNXsaVIOSZICzTWVKqRz1XVR4fdyKJxEpFhHCIu0ui9SeB887IdcS3KshvNqJo3Jm0LmBLL1vzcbucc7T02wiqvdDSPO7TO8Wlc7sJXwmMImEDBkPYQTHmeOqsKbW0OiGuJniwg93pBt0BqNhn3gxtYLrmjha+PqO9gVR6XkV"
  ],
  "state": "pending",
  "storage": "01000000-0000-4000-8000-000160010100",
  "taints": [
    {
      "effect": "NoSchedule",
      "key": "environment",
      "value": "development"
    }
  ]
}

json

application/json

Get node group details

GET

https://api.upcloud.com

/1.3/kubernetes/{uuid}/node-groups/{name}

Returns node group details by given {node_group_name}. Cluster is identified by given {uuid}.

Get node group details › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

Get node group details › Responses

200 getNodeGroupDetails response

Kubernetes cluster node

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

plan

kubernetesNodeGroupPlan · required

Node group plan

kubernetesNode[] · required

List of node group nodes (experimental)

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

Node group cloud native plan properties

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

List of taints

anti_affinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates

Enable periodic package updates on node

Delete node group

DELETE

https://api.upcloud.com

/1.3/kubernetes/{uuid}/node-groups/{name}

Deletes an existing node group by given Kubernetes cluster {uuid} and {node_group_name}.

Delete node group › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

Delete node group › Responses

202 deleteNodeGroup response

Message

kubernetesAccepted

message

kubernetesMessage

Message text content

Modify node group

PATCH

https://api.upcloud.com

/1.3/kubernetes/{uuid}/node-groups/{name}

Modifies an existing node group of a cluster. Cluster is identified by given {uuid} and node group by {node_group_name}.

Modify node group › path Parameters

uuid

kubernetesUuid · uuid · required

UUID

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

Modify node group › Request Body

kubernetesNodeGroupPatch

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

Modify node group › Responses

200 patchNodeGroup response

Node group for a Kubernetes cluster

count

kubernetesCount · int32 · min: 0 · max: 16 · required

Amount of nodes in a node group

name

kubernetesName · pattern: ^[a-z0-9]([-a-z0-9]*… · required

Name

plan

kubernetesNodeGroupPlan · required

Node group plan

List of Kubelet arguments

kubernetesLabel[] · unique

List of labels

Node group custom plan properties

Node group cloud native plan properties

Node group GPU plan properties

ssh_keys

kubernetesSshKey[] · unique

List of public SSH keys

state

kubernetesNodeGroupState · enum

Node group operational state

Enum values:

failed

pending

running

terminating

unknown

scaling-up

scaling-down

storage

kubernetesStorage · uuid

Storage UUID to use as a template

storage_encryption

kubernetesStorageEncryption · enum

The storage encryption strategy.

Enum values:

data-at-rest

none

List of taints

anti_affinity

Enable anti-affinity policies

Default: false

utility_network_access

Enable utility network access

Default: true

node_updates