KubernetesApi

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_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.

Example

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)

Get a Kubernetes Cluster by ID

Retrieves the K8s cluster specified by its ID.

Example

Parameters

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]

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)

Get Kubernetes Clusters

Retrieves a list of all K8s clusters provisioned under your account.

Example

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

KubernetesClusters

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)

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.

Example

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 a Kubernetes Node Pool by ID

Deletes the K8s node pool specified by its ID.

Example

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)

Get a Kubernetes Node Pool by ID

Retrieves the K8s node pool specified by its ID.

Example

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

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)

Get Kubernetes Node Pools

Retrieves a list of K8s node pools of a cluster specified by its ID.

Example

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

KubernetesNodePools

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 a Kubernetes Node by ID

Deletes the K8s node specified by its ID.

Example

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)

Get Kubernetes Node by ID

Retrieves the K8s node specified by its ID.

Example

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

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)

Get Kubernetes Nodes

Retrieves the list of all K8s nodes of the specified node pool.

Example

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

KubernetesNodes

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

k8s_nodepools_nodes_replace_post

k8s_nodepools_nodes_replace_post(k8s_cluster_id, nodepool_id, node_id, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Recreate a Kubernetes Node by ID

Recreates the K8s node specified by its ID. If a node becomes unusable, Managed Kubernetes allows you to recreate it with a configuration based on the node pool template. Once the status is 'Active,' all the pods from the failed node will be migrated to the new node. The node pool has an additional billable 'active' node during this process.

Example

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_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

Creates a node pool inside the specified K8s cluster.

Example

Parameters

Name
Type
Description
Notes

k8s_cluster_id

str

The unique ID of the Kubernetes cluster.

kubernetes_node_pool

The Kubernetes node pool to create.

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

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 a Kubernetes Node Pool by ID

Modifies the K8s node pool specified by its ID.

Example

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.

kubernetes_node_pool

Details 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

KubernetesNodePool

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

k8s_post

KubernetesCluster k8s_post(kubernetes_cluster, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Create a Kubernetes Cluster

Creates a K8s cluster provisioned under your account.

Example

Parameters

Name
Type
Description
Notes

kubernetes_cluster

The Kubernetes cluster to create.

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

KubernetesCluster

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

k8s_put

KubernetesCluster k8s_put(k8s_cluster_id, kubernetes_cluster, pretty=pretty, depth=depth, x_contract_number=x_contract_number)

Modify a Kubernetes Cluster by ID

Modifies the K8s cluster specified by its ID.

Example

Parameters

Name
Type
Description
Notes

k8s_cluster_id

str

The unique ID of the Kubernetes cluster.

kubernetes_cluster

The modified 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

KubernetesCluster

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

k8s_versions_default_get

str k8s_versions_default_get()

Get Default Kubernetes Version

Retrieves the current default K8s version to be used by the clusters and node pools.

Example

Parameters

This endpoint does not need any parameter.

Return type

str

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

k8s_versions_get

list[str] k8s_versions_get()

Get Kubernetes Versions

Lists available K8s versions.

Example

Parameters

This endpoint does not need any parameter.

Return type

list[str]

Authorization

Basic Authentication, Token Authentication

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

Last updated