kubernetes

List clusters

Returns a list of Kubernetes clusters.

get/1.3/kubernetes

Request

  • Base URL: https://api.upcloud.com
  • URL: https://api.upcloud.com/1.3/kubernetes
  • Auth: HTTP bearer

Response

200 getClusters response

control_plane_ip_filterKubernetesIPBlock[]

List of IP blocks

namestring required

Name

networkstring required

Network UUID

network_cidrstring

CIDR of the given network

storage_encryption'data-at-rest' | 'none'

The default storage encryption strategy for all node groups.

state'failed' | 'pending' | 'running' | 'terminated' | 'terminating' | 'unknown' | 'suspended' | 'upgrading' | 'upgrade-pending' | 'upgrade-failed'

Cluster operational state

uuidstring uuid

UUID

zonestring required

UpCloud zone to provision the Kubernetes cluster in

plan'development' | 'production-small' | 'dev-md' | 'prod-md' | 'prod-md-ha'

Cluster plan

private_node_groupsboolean

Enable private node groups

versionstring required

Kubernetes version identifier

labelsunknown required

Example response

[
  {
    "node_groups": [
      {
        "node_updates": {
          "schedule_time": "06:00"
        }
      }
    ],
    "authentication": [
      {
        "issuer_url": "https://accounts.myoidcprovider.com",
        "discovery_url": "https://accounts.myoidcprovider.com/.well-known/openid-configuration",
        "audiences": [
          "client-id-123"
        ],
        "claim_mappings": {
          "username": {
            "claim": "email",
            "prefix": "oidc:",
            "expression": "claims.email"
          },
          "groups": {
            "claim": "email",
            "prefix": "oidc:",
            "expression": "claims.email"
          },
          "uid": {
            "claim": "sub",
            "expression": "claims.sub"
          },
          "extra": [
            {
              "key": "example.org/foo",
              "value_expression": "claims.some_claim"
            }
          ]
        },
        "claim_validation_rules": [
          {
            "claim": "hd",
            "required_value": "upcloud.com",
            "expression": "claims.hd == 'upcloud.com'",
            "message": "User must belong to the upcloud.com organization domain."
          }
        ],
        "user_validation_rules": [
          {
            "expression": "!user.username.startsWith('system:')",
            "message": "Username must not start with the system: prefix."
          }
        ]
      }
    ]
  }
]

Changes

No recorded changes to this operation across all 1 revision of this API.