KubernetesApi
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
DELETE /k8s/{k8sClusterId} | Delete a Kubernetes Cluster by ID | |
GET /k8s/{k8sClusterId} | Get a Kubernetes Cluster by ID | |
GET /k8s | Get Kubernetes Clusters | |
GET /k8s/{k8sClusterId}/kubeconfig | Get Kubernetes Configuration File | |
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Delete a Kubernetes Node Pool by ID | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Get a Kubernetes Node Pool by ID | |
GET /k8s/{k8sClusterId}/nodepools | Get Kubernetes Node Pools | |
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Delete a Kubernetes Node by ID | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Get Kubernetes Node by ID | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes | Get Kubernetes Nodes | |
POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace | Recreate a Kubernetes Node by ID | |
POST /k8s/{k8sClusterId}/nodepools | Create a Kubernetes Node Pool | |
PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Modify a Kubernetes Node Pool by ID | |
POST /k8s | Create a Kubernetes Cluster | |
PUT /k8s/{k8sClusterId} | Modify a Kubernetes Cluster by ID | |
GET /k8s/versions/default | Get Default Kubernetes Version | |
GET /k8s/versions | Get Kubernetes Versions |
k8s_delete(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete a Kubernetes Cluster by ID
Deletes the K8s cluster specified by its ID.
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 a Kubernetes Cluster by ID
api_instance.k8s_delete(k8s_cluster_id)
except ApiException as e:
print('Exception when calling KubernetesApi.k8s_delete: %s\n' % e)
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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesCluster k8s_find_by_cluster_id(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get a Kubernetes Cluster by ID
Retrieves the K8s cluster specified by its ID.
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 K8s cluster to be retrieved.
try:
# Get a Kubernetes Cluster by ID
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)
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | str | The unique ID of the K8s cluster to be retrieved. | |
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesClusters k8s_get(pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get Kubernetes Clusters
Retrieves a list of all K8s clusters provisioned under your account.
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:
# Get 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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
str k8s_kubeconfig_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get Kubernetes Configuration File
Retrieves the configuration file for the specified K8s cluster. You can define the format (YAML or JSON) of the returned file in the Accept header. By default, 'application/yaml' is specified.
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:
# Get Kubernetes Configuration File
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)
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] |
str
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/yaml, application/x-yaml, application/json
k8s_nodepools_delete(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete a Kubernetes Node Pool by ID
Deletes the K8s node pool specified by its ID.
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 a Kubernetes Node Pool by ID
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)
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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesNodePool k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get a Kubernetes Node Pool by ID
Retrieves the K8s node pool specified by its ID.
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:
# Get a Kubernetes Node Pool by ID
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesNodePools k8s_nodepools_get(k8s_cluster_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get Kubernetes Node Pools
Retrieves a list of K8s node pools of a cluster specified by its ID.
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:
# Get 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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8s_nodepools_nodes_delete(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Delete a Kubernetes Node by ID
Deletes the K8s node specified by its ID.
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 a Kubernetes Node by ID
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)
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] |
void (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesNode k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)
Get Kubernetes Node by ID
Retrieves the K8s node specified by its ID.
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:
# Get Kubernetes Node by ID
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)
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] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
KubernetesNodes k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)