KubernetesApi
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
DELETE /k8s/{k8sClusterId} | Delete Kubernetes Cluster | |
GET /k8s/{k8sClusterId} | Retrieve Kubernetes Cluster | |
GET /k8s | List Kubernetes Clusters | |
GET /k8s/{k8sClusterId}/kubeconfig | Retrieve Kubernetes Configuration File | |
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Delete Kubernetes Node Pool | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Retrieve Kubernetes Node Pool | |
GET /k8s/{k8sClusterId}/nodepools | List Kubernetes Node Pools | |
DELETE /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Delete Kubernetes node | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} | Retrieve Kubernetes node | |
GET /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes | Retrieve Kubernetes nodes. | |
POST /k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace | Recreate the Kubernetes node | |
POST /k8s/{k8sClusterId}/nodepools | Create a Kubernetes Node Pool | |
PUT /k8s/{k8sClusterId}/nodepools/{nodepoolId} | Modify Kubernetes Node Pool | |
POST /k8s | Create Kubernetes Cluster | |
PUT /k8s/{k8sClusterId} | Modify Kubernetes Cluster | |
GET /k8s/versions/{clusterVersion}/compatibilities | Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster. | |
GET /k8s/versions/default | Retrieve the current default kubernetes version for clusters and nodepools. | |
GET /k8s/versions | Retrieve available Kubernetes versions |
k8s_delete
Object k8s_delete(k8s_cluster_id, opts)
Delete Kubernetes Cluster
This will remove a Kubernetes Cluster.
Examples
Using the k8s_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> k8s_delete_with_http_info(k8s_cluster_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | 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
k8s_find_by_cluster_id(k8s_cluster_id, opts)
Retrieve Kubernetes Cluster
This will retrieve a single Kubernetes Cluster.
Examples
Using the k8s_find_by_cluster_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_find_by_cluster_id_with_http_info(k8s_cluster_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_get
k8s_get(opts)
List Kubernetes Clusters
You can retrieve a list of all kubernetes clusters associated with a contract
Examples
Using the k8s_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_get_with_http_info(opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_kubeconfig_get
k8s_kubeconfig_get(k8s_cluster_id, opts)
Retrieve Kubernetes Configuration File
You can retrieve kubernetes configuration file for the kubernetes cluster.
Examples
Using the k8s_kubeconfig_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_kubeconfig_get_with_http_info(k8s_cluster_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
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, opts)
Delete Kubernetes Node Pool
This will remove a Kubernetes Node Pool.
Examples
Using the k8s_nodepools_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> k8s_nodepools_delete_with_http_info(k8s_cluster_id, nodepool_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | 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
k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, opts)
Retrieve Kubernetes Node Pool
You can retrieve a single Kubernetes Node Pool.
Examples
Using the k8s_nodepools_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_get
k8s_nodepools_get(k8s_cluster_id, opts)
List Kubernetes Node Pools
You can retrieve a list of all kubernetes node pools part of kubernetes cluster
Examples
Using the k8s_nodepools_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_get_with_http_info(k8s_cluster_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
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, opts)
Delete Kubernetes node
This will remove a Kubernetes node.
Examples
Using the k8s_nodepools_nodes_delete_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> k8s_nodepools_nodes_delete_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
node_id | String | The unique ID of the Kubernetes node | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | 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
k8s_nodepools_nodes_find_by_id(k8s_cluster_id, nodepool_id, node_id, opts)
Retrieve Kubernetes node
You can retrieve a single Kubernetes Node.
Examples
Using the k8s_nodepools_nodes_find_by_id_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_nodes_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
node_id | String | The unique ID of the Kubernetes Node. | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: Not defined
Accept: application/json
k8s_nodepools_nodes_get
k8s_nodepools_nodes_get(k8s_cluster_id, nodepool_id, opts)
Retrieve Kubernetes nodes.
You can retrieve all nodes of Kubernetes Node Pool.
Examples
Using the k8s_nodepools_nodes_get_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_nodes_get_with_http_info(k8s_cluster_id, nodepool_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
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, opts)
Recreate the Kubernetes node
You can recreate a single Kubernetes Node. Managed Kubernetes starts a process which based on the nodepool's template creates & configures a new node, waits for status "ACTIVE", and migrates all the pods from the faulty node, deleting it once empty. While this operation occurs, the nodepool will have an extra billable "ACTIVE" node.
Examples
Using the k8s_nodepools_nodes_replace_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(Object, Integer, Hash)> k8s_nodepools_nodes_replace_post_with_http_info(k8s_cluster_id, nodepool_id, node_id, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
node_id | String | The unique ID of the Kubernetes Node. | |
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | 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
k8s_nodepools_post(k8s_cluster_id, kubernetes_node_pool, opts)
Create a Kubernetes Node Pool
This will create a new Kubernetes Node Pool inside a Kubernetes Cluster.
Examples
Using the k8s_nodepools_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_post_with_http_info(k8s_cluster_id, kubernetes_node_pool, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
kubernetes_node_pool | Details of the Kubernetes Node Pool | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8s_nodepools_put
k8s_nodepools_put(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
Modify Kubernetes Node Pool
This will modify the Kubernetes Node Pool.
Examples
Using the k8s_nodepools_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_nodepools_put_with_http_info(k8s_cluster_id, nodepool_id, kubernetes_node_pool, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
nodepool_id | String | The unique ID of the Kubernetes Node Pool | |
kubernetes_node_pool | Details of the Kubernetes Node Pool | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8s_post
k8s_post(kubernetes_cluster, opts)
Create Kubernetes Cluster
This will create a new Kubernetes Cluster.
Examples
Using the k8s_post_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_post_with_http_info(kubernetes_cluster, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
kubernetes_cluster | Details of the Kubernetes Cluster | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8s_put
k8s_put(k8s_cluster_id, kubernetes_cluster, opts)
Modify Kubernetes Cluster
This will modify the Kubernetes Cluster.
Examples
Using the k8s_put_with_http_info variant
This returns an Array which contains the response data, status code and headers.
<Array(, Integer, Hash)> k8s_put_with_http_info(k8s_cluster_id, kubernetes_cluster, opts)
Parameters
Name | Type | Description | Notes |
---|---|---|---|
k8s_cluster_id | String | The unique ID of the Kubernetes Cluster | |
kubernetes_cluster | Details of the Kubernetes Cluster | ||
pretty | Boolean | Controls whether response is pretty-printed (with indentation and new lines) | [optional][default to true] |
depth | Integer | 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 | Integer | Users having more than 1 contract need to provide contract number, against which all API requests should be executed | [optional] |
Return type
Authorization
Basic Authentication, Token Authentication
HTTP request headers
Content-Type: application/json
Accept: application/json
k8s_versions_compatibilities_get
Array<String> k8s_versions_compatibilities_get(cluster_version)
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
You can retrieve a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.