How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

UpCloud Kubernetes API

Kubernetes is a container orchestration system for automating, managing and scaling software deployment.Managed Kubernetes allows you to easily create Kubernetes clusters without having to take care about low level details.

UpCloud Kubernetes API is one of 29 APIs that UpCloud publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Kubernetes. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 24 operations across 13 paths, and defines 74 schemas. It is described by OpenAPI 3.2.0, at version 1.3.

Requests are made against a single base URL, https://api.upcloud.com.

24 operations 13 paths 74 schemas 4 DELETE11 GET2 PATCH4 POST3 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
1.3
Base URL
https://api.upcloud.com
Authentication
HTTP Bearer
Contact
License
Terms of Service
Resource Areas
1

Authentication & Security 1

UpCloud Kubernetes API declares 1 security scheme for authenticating requests. It accepts HTTP bearer tokens (apiToken). By default, every request must be authenticated.

  • apiToken — UpCloud API uses HTTP Bearer authentication. An API token is required to authenticate. The API token can be created in the UpCloud control panel. Alternatively…

Paths & Operations 24

Across 13 paths, the API surfaces 24 operations — 4 DELETE, 11 GET, 2 PATCH, 4 POST, 3 PUT. Each is listed below with its method, path, parameters, and response codes.

Kubernetes 24

Kubernetes is a container orchestration system for automating, managing and scaling software deployment. Managed Kubernetes allows you to easily create Kubernetes clusters without…

GET
/1.3/kubernetes
List clusters
listKubernetesClusters → 200400401default
POST
/1.3/kubernetes
Create cluster
createKubernetesCluster body → 201400401404422default
GET
/1.3/kubernetes/{uuid}
Get cluster details
getKubernetesCluster 1 param → 200400401404default
DELETE
/1.3/kubernetes/{uuid}
Delete cluster
deleteKubernetesCluster 1 param → 202401404default
PATCH
/1.3/kubernetes/{uuid}
Modify cluster
modifyKubernetesCluster 1 param body → 200400401404default
GET
/1.3/kubernetes/{uuid}/kubeconfig
Get kubeconfig
getKubernetesClusterKubeconfig 1 param → 200401404default
GET
/1.3/kubernetes/{uuid}/available-upgrades
Get available upgrades
getKubernetesClusterAvailableUpgrades 1 param → 200401404default
POST
/1.3/kubernetes/{uuid}/available-upgrades
Upgrade cluster
upgradeKubernetesCluster 1 param body → 201401404422default
GET
/1.3/kubernetes/{uuid}/node-groups
List node groups
listKubernetesClusterNodeGroups 1 param → 200401404default
POST
/1.3/kubernetes/{uuid}/node-groups
Create node group
createKubernetesClusterNodeGroup 1 param body → 201401404422default
GET
/1.3/kubernetes/{uuid}/node-groups/{name}
Get node group details
getKubernetesClusterNodeGroup 2 params → 200401404default
DELETE
/1.3/kubernetes/{uuid}/node-groups/{name}
Delete node group
deleteKubernetesClusterNodeGroup 2 params → 202401404default
PATCH
/1.3/kubernetes/{uuid}/node-groups/{name}
Modify node group
modifyKubernetesClusterNodeGroup 2 params body → 200401404422default
DELETE
/1.3/kubernetes/{uuid}/node-groups/{name}/{node-name}
Delete node group node
deleteKubernetesClusterNodeGroupNode 3 params → 202401404default
GET
/1.3/kubernetes/plans
List plans
listKubernetesPlans → 200401default
GET
/1.3/kubernetes/versions
List versions
listKubernetesVersions → 200401default
GET
/1.3/kubernetes/{uuid}/authentication
List cluster authentication entries
listClusterAuthentication 1 param → 200401404default
PUT
/1.3/kubernetes/{uuid}/authentication
Replace the full cluster authentication configuration
setClusterAuthentication 1 param body → 200400401404default
POST
/1.3/kubernetes/{uuid}/authentication
Create a cluster authentication entry
createClusterAuthentication 1 param body → 201400401404409default
PUT
/1.3/kubernetes/{uuid}/authentication/import
Import a full cluster authentication configuration
importClusterAuthentication 1 param body → 200400401404default
GET
/1.3/kubernetes/{uuid}/authentication/{name}
Get a cluster authentication entry
getClusterAuthentication 2 params → 200401404default
PUT
/1.3/kubernetes/{uuid}/authentication/{name}
Update a cluster authentication entry
updateClusterAuthentication 2 params body → 200400401404default
DELETE
/1.3/kubernetes/{uuid}/authentication/{name}
Delete a cluster authentication entry
deleteClusterAuthentication 2 params → 204401404default
GET
/1.3/kubernetes/{uuid}/authentication/{name}/kubeconfig
Get OIDC kubeconfig
getKubernetesClusterOIDCKubeconfig 3 params → 200400401404default

Schemas 74

The contract defines 74 schemas that model the data the API accepts and returns. The most detailed are kubernetesNodeGroup (16 properties), kubernetesCluster (14 properties), kubernetesAuthenticationIssuerConfig (9 properties), kubernetesError (5 properties). Each schema is shown below with its type and property counts.

kubernetesMessage
string
Message text content
kubernetesStorage
string
Storage UUID to use as a template
kubernetesKey
string
Key of a key-value pair
kubernetesClusterAvailableUpgrades
object
1 property 1 required
kubernetesErrorStatus
integer
HTTP Status code
kubernetesClusterPatch
object
3 properties 1 required
kubernetesClusterPlan
string
Cluster plan
kubernetesSshKeys
array
List of public SSH keys
kubernetesErrorInvalidParams
string
list of parameters describing a specific part(s) of the request that caused the error
kubernetesClusterUpgradeStrategyType
string
upgrade strategy type
kubernetesClaimOrExpression
object
Maps a user attribute from either a JWT claim or a CEL expression. Claim and expression are mutually exclusive.
2 properties
kubernetesStorageTier
string
The storage tier to use.
kubernetesStorageSize
integer
The size of the storage device in gigabytes.
kubernetesCluster
object
Kubernetes cluster
14 properties 5 required
kubernetesErrorTitle
string
human-readable description of the error
kubernetesNetwork
string
Network UUID
kubernetesNodeGroups
array
List of node groups
kubernetesPlan
object
Plan to assign to a node group
2 properties 2 required
kubernetesDescription
string
Plan description
kubernetesUtilityNetworkAccess
boolean
Enable utility network access
kubernetesDefaultStorageEncryption
kubernetesNodeGroupCustomPlan
object
Node group custom plan properties
4 properties 3 required
kubernetesClusterKubeconfig
object
Kubernetes cluster kubeconfig
1 property 1 required
kubernetesNetworkCIDR
string
CIDR of the given network
kubernetesNodeGroupPlan
string
Node group plan
kubernetesTaint
object
Kubernetes taint to assign to nodes in a group
3 properties 3 required
kubernetesClusters
array
List of Kubernetes clusters
kubernetesNodeGroupDetails
object
Kubernetes cluster node
1 property
kubernetesCount
integer
Amount of nodes in a node group
kubernetesUserValidationRule
object
CEL expression applied to the final authenticated user.
2 properties 1 required
kubernetesStorageEncryption
string
The storage encryption strategy.
kubernetesClaimValidationRule
object
CEL expression used to validate a token claim.
4 properties
kubernetesNodeUpdates
object
Enable periodic package updates on node
3 properties 3 required
kubernetesZone
string
UpCloud zone to provision the Kubernetes cluster in
kubernetesAuthenticationConfigurationYAML
string
kube-apiserver v1 AuthenticationConfiguration YAML document
kubernetesClusterUpgradeStrategy
object
upgrade strategy for node group upgrades
1 property 1 required
kubernetesTaints
array
List of taints
kubernetesPrivateNodeGroups
boolean
Enable private node groups
kubernetesKubeletArg
object
Kubelet argument presented as key-value pair
2 properties 2 required
kubernetesNodeState
string
Node operational state
kubernetesExtraMapping
object
Maps a token claim to an extra user attribute using a CEL expression.
2 properties 2 required
kubernetesNode
object
Kubernetes cluster node
4 properties 4 required
kubernetesPlans
array
List of plans
kubernetesClusterVersion
string
Kubernetes version identifier
kubernetesError
object
Response error
5 properties 4 required
kubernetesNodeGroupState
string
Node group operational state
kubernetesErrorCorrelationID
string
unique string that identifies the request that caused the error
kubernetesIPBlock
string
IP prefix of a single IPv4 address or a network CIDR
kubernetesAuthenticationConfiguration
array
List of OIDC issuers and their claim validation rules.
kubernetesLabels
array
List of labels
kubernetesClaimMappings
object
Rules for mapping token claims to Kubernetes user attributes.
4 properties
kubernetesVersions
array
List of Kubernetes versions
kubernetesKubeconfig
string
Kubeconfig
kubernetesAccepted
object
Message
1 property
kubernetesPrefixedClaimOrExpression
object
Maps a user attribute from either a JWT claim (optionally prefixed) or a CEL expression. Claim and expression are mutually exclusive.
3 properties
kubernetesValue
string
Value of a key-value pair
kubernetesNodeGroup
object
Node group for a Kubernetes cluster
16 properties 3 required
kubernetesNodeName
string
Node name
kubernetesVersion
object
Kubernetes version
2 properties 2 required
kubernetesClusterAvailableUpgradesPost
object
2 properties 1 required
kubernetesNodeGroupCloudNativePlan
object
Node group cloud native plan properties
2 properties 1 required
kubernetesAuthenticationIssuerConfig
object
9 properties 3 required
kubernetesNodeGroupPatch
object
1 property 1 required
kubernetesEffect
string
Taint effect
kubernetesAntiAffinity
boolean
Enable anti-affinity policies
kubernetesUuid
string
UUID
kubernetesNodeGroupGPUPlan
object
Node group GPU plan properties
2 properties 1 required
kubernetesIPBlocks
array
List of IP blocks
kubernetesLabel
object
Label for identifying node groups, presented as key-value pair
2 properties 1 required
kubernetesErrorType
string
URI to a page describing the problem
kubernetesClusterState
string
Cluster operational state
kubernetesName
string
Name
kubernetesSshKey
string
Public SSH key for accessing the nodes in a group
kubernetesKubeletArgs
array
List of Kubelet arguments

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

upcloud-kubernetes-api-openapi.yml Raw ↑

Other APIs UpCloud publishes across the network.

UpCloud Account API
UpCloud Account Tokens API
UpCloud Audit Logs API
UpCloud Currency API
UpCloud Database API
UpCloud Device API
UpCloud Events API
UpCloud File Storage API
UpCloud Firewall Ruleset API
UpCloud Gateway API
UpCloud Ip Address API
UpCloud Load Balancer API
Where this information came from

This is an independent, third-party profile of UpCloud Kubernetes API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.