KubernetesApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
DELETE /k8s/{k8sClusterId}
Delete Kubernetes Cluster
GET /k8s/{k8sClusterId}
Retrieve Kubernetes Cluster
GET /k8s
List Kubernetes Clusters
GET /k8s/{k8sClusterId}/kubeconfig
Retrieve Kubernetes Configuration File
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Delete Kubernetes Node Pool
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Retrieve Kubernetes Node Pool
GET /k8s/{k8sClusterId}/nodepools
List Kubernetes Node Pools
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Delete Kubernetes node
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Retrieve Kubernetes node
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes
Retrieve Kubernetes nodes.
POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace
Recreate the Kubernetes node
POST /k8s/{k8sClusterId}/nodepools
Create a Kubernetes Node Pool
PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Modify Kubernetes Node Pool
POST /k8s
Create Kubernetes Cluster
PUT /k8s/{k8sClusterId}
Modify Kubernetes Cluster
GET /k8s/versions/{clusterVersion}/compatibilities
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
GET /k8s/versions/default
Retrieve the current default kubernetes version for clusters and nodepools.
GET /k8s/versions
Retrieve available Kubernetes versions
k8sDelete
object k8sDelete(k8sClusterId, opts)
Delete Kubernetes Cluster
This will remove a Kubernetes Cluster.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sFindByClusterId
k8sFindByClusterId(k8sClusterId, opts)
Retrieve Kubernetes Cluster
This will retrieve a single Kubernetes Cluster.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sGet
k8sGet(opts)
List Kubernetes Clusters
You can retrieve a list of all kubernetes clusters associated with a contract
Examples
Parameters
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sKubeconfigGet
k8sKubeconfigGet(k8sClusterId, opts)
Retrieve Kubernetes Configuration File
You can retrieve kubernetes configuration file for the kubernetes cluster.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsDelete
object k8sNodepoolsDelete(k8sClusterId, nodepoolId, opts)
Delete Kubernetes Node Pool
This will remove a Kubernetes Node Pool.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsFindById
k8sNodepoolsFindById(k8sClusterId, nodepoolId, opts)
Retrieve Kubernetes Node Pool
You can retrieve a single Kubernetes Node Pool.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsGet
k8sNodepoolsGet(k8sClusterId, opts)
List Kubernetes Node Pools
You can retrieve a list of all kubernetes node pools part of kubernetes cluster
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsNodesDelete
object k8sNodepoolsNodesDelete(k8sClusterId, nodepoolId, nodeId, opts)
Delete Kubernetes node
This will remove a Kubernetes node.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
nodeId
string
The unique ID of the Kubernetes node
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsNodesFindById
k8sNodepoolsNodesFindById(k8sClusterId, nodepoolId, nodeId, opts)
Retrieve Kubernetes node
You can retrieve a single Kubernetes Node.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
nodeId
string
The unique ID of the Kubernetes Node.
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsNodesGet
k8sNodepoolsNodesGet(k8sClusterId, nodepoolId, opts)
Retrieve Kubernetes nodes.
You can retrieve all nodes of Kubernetes Node Pool.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsNodesReplacePost
object k8sNodepoolsNodesReplacePost(k8sClusterId, nodepoolId, nodeId, opts)
Recreate the Kubernetes node
You can recreate a single Kubernetes Node. Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
nodeId
string
The unique ID of the Kubernetes Node.
[default to undefined]
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sNodepoolsPost
k8sNodepoolsPost(k8sClusterId, kubernetesNodePool, opts)
Create a Kubernetes Node Pool
This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
kubernetesNodePool
Details of the Kubernetes Node Pool
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8sNodepoolsPut
k8sNodepoolsPut(k8sClusterId, nodepoolId, kubernetesNodePool, opts)
Modify Kubernetes Node Pool
This will modify the Kubernetes Node Pool.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
nodepoolId
string
The unique ID of the Kubernetes Node Pool
[default to undefined]
kubernetesNodePool
Details of the Kubernetes Node Pool
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8sPost
k8sPost(kubernetesCluster, opts)
Create Kubernetes Cluster
This will create a new Kubernetes Cluster.
Examples
Parameters
kubernetesCluster
Details of the Kubernetes Cluster
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8sPut
k8sPut(k8sClusterId, kubernetesCluster, opts)
Modify Kubernetes Cluster
This will modify the Kubernetes Cluster.
Examples
Parameters
k8sClusterId
string
The unique ID of the Kubernetes Cluster
[default to undefined]
kubernetesCluster
Details of the Kubernetes Cluster
pretty
boolean
Controls whether response is pretty-printed (with indentation and new lines)
[optional][default to true]
depth
number
Controls the details depth of response objects. Eg. GET /datacenters/[ID] - depth=0: only direct properties are included. Children (servers etc.) are not included - depth=1: direct properties and children references are included - depth=2: direct properties and children properties are included - depth=3: direct properties and children properties and children's children are included - depth=... and so on
[optional][default to 0]
xContractNumber
number
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional][default to undefined]
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8sVersionsCompatibilitiesGet
Array<string> k8sVersionsCompatibilitiesGet(clusterVersion)
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
You can retrieve a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
Examples
Parameters
clusterVersion
string
[default to undefined]
Return type
Array<string>
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sVersionsDefaultGet
string k8sVersionsDefaultGet
Retrieve the current default kubernetes version for clusters and nodepools.
You can retrieve the current default kubernetes version for clusters and nodepools.
Examples
Parameters
This endpoint does not need any parameter.
Return type
string
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8sVersionsGet
Array<string> k8sVersionsGet
Retrieve available Kubernetes versions
You can retrieve a list of available kubernetes versions
Examples
Parameters
This endpoint does not need any parameter.
Return type
Array<string>
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
Last updated