Links

KubernetesApi

KubernetesApi

All URIs are relative to https://api.ionos.com/cloudapi/v6
Method
HTTP request
Description
DELETE /k8s/{k8sClusterId}
Delete Kubernetes clusters
GET /k8s/{k8sClusterId}
Retrieve Kubernetes clusters
k8s_get
GET /k8s
List Kubernetes clusters
GET /k8s/{k8sClusterId}/kubeconfig
Retrieve Kubernetes configuration files
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Delete Kubernetes node pools
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Retrieve Kubernetes node pools
GET /k8s/{k8sClusterId}/nodepools
List Kubernetes node pools
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Delete Kubernetes nodes
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}
Retrieve Kubernetes nodes
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes
List Kubernetes nodes
POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace
Recreate Kubernetes nodes
POST /k8s/{k8sClusterId}/nodepools
Create Kubernetes node pools
PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId}
Modify Kubernetes node pools
k8s_post
POST /k8s
Create Kubernetes clusters
k8s_put
PUT /k8s/{k8sClusterId}
Modify Kubernetes clusters
GET /k8s/versions/default
Retrieve current default Kubernetes version
GET /k8s/versions
List Kubernetes versions

k8s_delete

k8s_delete(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes clusters
Delete the specified Kubernetes cluster.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Delete Kubernetes clusters
api_instance.k8s_delete(k8s_cluster_id)
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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

void (empty response body)

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 clusters
Retrieve the specified Kubernetes cluster.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Retrieve Kubernetes clusters
api_response = api_instance.k8s_find_by_cluster_id(k8s_cluster_id)
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

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
List all available Kubernetes clusters.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
with ionoscloud.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = ionoscloud.KubernetesApi(api_client)
try:
# List Kubernetes clusters
api_response = api_instance.k8s_get()
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

k8s_kubeconfig_get

str k8s_kubeconfig_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Retrieve Kubernetes configuration files
Retrieve a configuration file for the specified Kubernetes cluster, in YAML or JSON format as defined in the Accept header; the default Accept header is application/yaml.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Retrieve Kubernetes configuration files
api_response = api_instance.k8s_kubeconfig_get(k8s_cluster_id)
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

str

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/yaml, application/x-yaml, application/json

k8s_nodepools_delete

k8s_nodepools_delete(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes node pools
Delete the specified Kubernetes node pool.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Delete Kubernetes node pools
api_instance.k8s_nodepools_delete(k8s_cluster_id, nodepool_id)
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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

void (empty response body)

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 pools
Retrieve the specified Kubernetes node pool.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Retrieve Kubernetes node pools
api_response = api_instance.k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id)
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

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
List all Kubernetes node pools, included the specified Kubernetes cluster.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# List Kubernetes node pools
api_response = api_instance.k8s_nodepools_get(k8s_cluster_id)
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

k8s_nodepools_nodes_delete

k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete Kubernetes nodes
Delete the specified Kubernetes node.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Delete Kubernetes nodes
api_instance.k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id)
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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

void (empty response body)

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 nodes
Retrieve the specified Kubernetes node.

Example

from __future__ import print_function
import time
import ionoscloud
from ionoscloud.rest import ApiException
# Defining the host is optional and defaults to https://api.ionos.com/cloudapi/v6
configuration = ionoscloud.Configuration(
host = 'https://api.ionos.com/cloudapi/v6',
)
# Example of configuring HTTP Basic Authorization
configuration.username = 'YOUR_USERNAME'
configuration.password = 'YOUR_PASSWORD'
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.
try:
# Retrieve Kubernetes nodes
api_response = api_instance.k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id)
print(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 the response is pretty-printed (with indentations and new lines).
[optional] [default to True]
depth
int
Controls the detail depth of the response objects. GET /datacenters/[ID] - depth=0: Only direct properties are included; children (servers and other elements) 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 with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json