KubernetesApi

KubernetesApi
All URIs are relative to https://api.ionos.com/cloudapi/v5​
Method
HTTP request
Description
​k8s_delete​
DELETE /k8s/{k8sClusterId}
Delete Kubernetes Cluster
​k8s_find_by_cluster_id​
GET /k8s/{k8sClusterId}
Retrieve Kubernetes Cluster
​k8s_get​
GET /k8s
List Kubernetes Clusters
​k8s_kubeconfig_get​
GET /k8s/{k8sClusterId}/kubeconfig
Retrieve Kubernetes Configuration File
​k8s_nodepools_delete​
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Delete Kubernetes Node Pool
​k8s_nodepools_find_by_id​
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Retrieve Kubernetes Node Pool
​k8s_nodepools_get​
GET /k8s/{k8sClusterId}/nodepools
List Kubernetes Node Pools
​k8s_nodepools_nodes_delete​
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Delete Kubernetes node
​k8s_nodepools_nodes_find_by_id​
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Retrieve Kubernetes node
​k8s_nodepools_nodes_get​
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes
Retrieve Kubernetes nodes.
​k8s_nodepools_nodes_replace_post​
POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace
Recreate the Kubernetes node
​k8s_nodepools_post​
POST /k8s/{k8sClusterId}/nodepools
Create a Kubernetes Node Pool
​k8s_nodepools_put​
PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Modify Kubernetes Node Pool
​k8s_post​
POST /k8s
Create Kubernetes Cluster
​k8s_put​
PUT /k8s/{k8sClusterId}
Modify Kubernetes Cluster
​k8s_versions_compatibilities_get​
GET /k8s/versions/{clusterVersion}/compatibilities
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
​k8s_versions_default_get​
GET /k8s/versions/default
Retrieve the current default kubernetes version for clusters and nodepools.
​k8s_versions_get​
GET /k8s/versions
Retrieve available Kubernetes versions
k8s_delete
object k8s_delete(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes Cluster
This will remove a Kubernetes Cluster.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes Cluster
      api_response = api_instance.k8s_delete(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_delete: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes Cluster
      api_response = api_instance.k8s_delete(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_delete: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_find_by_cluster_id
KubernetesCluster k8s_find_by_cluster_id(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes Cluster
This will retrieve a single Kubernetes Cluster.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Cluster
      api_response = api_instance.k8s_find_by_cluster_id(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_find_by_cluster_id: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Cluster
      api_response = api_instance.k8s_find_by_cluster_id(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_find_by_cluster_id: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesCluster​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_get
KubernetesClusters k8s_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List Kubernetes Clusters
You can retrieve a list of all kubernetes clusters associated with a contract
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # List Kubernetes Clusters
      api_response = api_instance.k8s_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_get: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # List Kubernetes Clusters
      api_response = api_instance.k8s_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_get: %s\n' % e)
Parameters
Name
Type
Description
Notes
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesClusters​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_kubeconfig_get
KubernetesConfig k8s_kubeconfig_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes Configuration File
You can retrieve kubernetes configuration file for the kubernetes cluster.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Configuration File
      api_response = api_instance.k8s_kubeconfig_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_kubeconfig_get: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Configuration File
      api_response = api_instance.k8s_kubeconfig_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_kubeconfig_get: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesConfig​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_delete
object k8s_nodepools_delete(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes Node Pool
This will remove a Kubernetes Node Pool.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_delete(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_delete: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_delete(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_delete: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_find_by_id
KubernetesNodePool k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes Node Pool
You can retrieve a single Kubernetes Node Pool.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_find_by_id: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_find_by_id: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesNodePool​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_get
KubernetesNodePools k8s_nodepools_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
List Kubernetes Node Pools
You can retrieve a list of all kubernetes node pools part of kubernetes cluster
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # List Kubernetes Node Pools
      api_response = api_instance.k8s_nodepools_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_get: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # List Kubernetes Node Pools
      api_response = api_instance.k8s_nodepools_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_get: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesNodePools​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_nodes_delete
object k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes node
This will remove a Kubernetes node.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes node
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_delete: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes node
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Delete Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_delete: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
node_id
str
The unique ID of the Kubernetes node
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_nodes_find_by_id
KubernetesNode k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes node
You can retrieve a single Kubernetes Node.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes Node.
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_find_by_id: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes Node.
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_find_by_id: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
node_id
str
The unique ID of the Kubernetes Node.
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesNode​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_nodes_get
KubernetesNodes k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes nodes.
You can retrieve all nodes of Kubernetes Node Pool.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes nodes.
      api_response = api_instance.k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_get: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Retrieve Kubernetes nodes.
      api_response = api_instance.k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_get: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesNodes​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_nodes_replace_post
object k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
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.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes Node.
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Recreate the Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_replace_post: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  node_id = 'node_id_example' # str | The unique ID of the Kubernetes Node.
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Recreate the Kubernetes node
      api_response = api_instance.k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_nodes_replace_post: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
nodepool_id
str
The unique ID of the Kubernetes Node Pool
​
node_id
str
The unique ID of the Kubernetes Node.
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
object
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_post
KubernetesNodePool k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Create a Kubernetes Node Pool
This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  kubernetes_node_pool = ionoscloud.KubernetesNodePoolForPost() # KubernetesNodePoolForPost | Details of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Create a Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_post: %s\n' % e)
Api Key Authentication (Token Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure Api Key access token for authorization: Token Authentication
configuration.api_key = {
  'Token Authentication': 'YOUR_API_TOKEN',
}
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  kubernetes_node_pool = ionoscloud.KubernetesNodePoolForPost() # KubernetesNodePoolForPost | Details of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth = 0 # int | 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)
  x_contract_number = 56 # int | Users having more than 1 contract need to provide contract number, against which all API requests should be executed (optional)
  try:
      # Create a Kubernetes Node Pool
      api_response = api_instance.k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
      pprint(api_response)
  except ApiException as e:
      print('Exception when calling KubernetesApi.k8s_nodepools_post: %s\n' % e)
Parameters
Name
Type
Description
Notes
k8s_cluster_id
str
The unique ID of the Kubernetes Cluster
​
kubernetes_node_pool
​KubernetesNodePoolForPost​
Details of the Kubernetes Node Pool
​
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[optional] [default to True]
depth
int
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]
x_contract_number
int
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
[optional]
Return type
​KubernetesNodePool​
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8s_nodepools_put
KubernetesNodePool k8s_nodepools_put(k8s_cluster_id, nodepool_id, kubernetes_node_pool, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Modify Kubernetes Node Pool
This will modify the Kubernetes Node Pool.
Example
Basic Authentication (Basic Authentication):
from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
from pprint import pprint
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = ionoscloud.Configuration(
  host = 'https://api.ionos.com/cloudapi/v5',
)
# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples with auth method are provided below
# Configure HTTP basic authorization: Basic Authentication
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
# Enter a context with an instance of the API client
with ionoscloud.ApiClient(configuration) as api_client:
  # Create an instance of the API class
  api_instance = ionoscloud.KubernetesApi(api_client)
  k8s_cluster_id = 'k8s_cluster_id_example' # str | The unique ID of the Kubernetes Cluster
  nodepool_id = 'nodepool_id_example' # str | The unique ID of the Kubernetes Node Pool
  kubernetes_node_pool = ionoscloud.KubernetesNodePoolForPut() # KubernetesNodePoolForPut | Details of the Kubernetes Node Pool
  pretty = True # bool | Controls whether response is pretty-printed (with indentation and new lines) (optional) (default to True)
  depth 
Method	HTTP request	Description
k8s_delete	DELETE /k8s/{k8sClusterId}	Delete Kubernetes Cluster
k8s_find_by_cluster_id	GET /k8s/{k8sClusterId}	Retrieve Kubernetes Cluster
k8s_get	GET /k8s	List Kubernetes Clusters
k8s_kubeconfig_get	GET /k8s/{k8sClusterId}/kubeconfig	Retrieve Kubernetes Configuration File
k8s_nodepools_delete	DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Delete Kubernetes Node Pool
k8s_nodepools_find_by_id	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Retrieve Kubernetes Node Pool
k8s_nodepools_get	GET /k8s/{k8sClusterId}/nodepools	List Kubernetes Node Pools
k8s_nodepools_nodes_delete	DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}	Delete Kubernetes node
k8s_nodepools_nodes_find_by_id	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}	Retrieve Kubernetes node
k8s_nodepools_nodes_get	GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes	Retrieve Kubernetes nodes.
k8s_nodepools_nodes_replace_post	POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace	Recreate the Kubernetes node
k8s_nodepools_post	POST /k8s/{k8sClusterId}/nodepools	Create a Kubernetes Node Pool
k8s_nodepools_put	PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}	Modify Kubernetes Node Pool
k8s_post	POST /k8s	Create Kubernetes Cluster
k8s_put	PUT /k8s/{k8sClusterId}	Modify Kubernetes Cluster
k8s_versions_compatibilities_get	GET /k8s/versions/{clusterVersion}/compatibilities	Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
k8s_versions_default_get	GET /k8s/versions/default	Retrieve the current default kubernetes version for clusters and nodepools.
k8s_versions_get	GET /k8s/versions	Retrieve available Kubernetes versions
Name	Type	Description	Notes
k8s_cluster_id	str	The unique ID of the Kubernetes Cluster
pretty	bool	Controls whether response is pretty-printed (with indentation and new lines)	[optional] [default to True]
depth	int	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]
x_contract_number	int	Users having more than 1 contract need to provide contract number, against which all API requests should be executed	[optional]