Links

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, opts)
Delete Kubernetes clusters
Delete the specified Kubernetes cluster.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Delete Kubernetes clusters
api_instance.k8s_delete(k8s_cluster_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_delete: #{e}"
end

Using the k8s_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.
<Array(nil, Integer, Hash)> k8s_delete_with_http_info(k8s_cluster_id, opts)
begin
# Delete Kubernetes clusters
data, status_code, headers = api_instance.k8s_delete_with_http_info(k8s_cluster_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_delete_with_http_info: #{e}"
end

Parameters

Name
Type
Description
Notes
k8s_cluster_id
String
The unique ID of the Kubernetes cluster.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

nil (empty response body)

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

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve Kubernetes clusters
result = api_instance.k8s_find_by_cluster_id(k8s_cluster_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_find_by_cluster_id: #{e}"
end

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)
begin
# Retrieve Kubernetes clusters
data, status_code, headers = api_instance.k8s_find_by_cluster_id_with_http_info(k8s_cluster_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <KubernetesCluster>
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_find_by_cluster_id_with_http_info: #{e}"
end

Parameters

Name
Type
Description
Notes
k8s_cluster_id
String
The unique ID of the Kubernetes cluster.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
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

k8s_get(opts)
List Kubernetes clusters
List all available Kubernetes clusters.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# List Kubernetes clusters
result = api_instance.k8s_get(opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_get: #{e}"
end

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)
begin
# List Kubernetes clusters
data, status_code, headers = api_instance.k8s_get_with_http_info(opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <KubernetesClusters>
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_get_with_http_info: #{e}"
end

Parameters

Name
Type
Description
Notes
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
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

String k8s_kubeconfig_get(k8s_cluster_id, opts)
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.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve Kubernetes configuration files
result = api_instance.k8s_kubeconfig_get(k8s_cluster_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_kubeconfig_get: #{e}"
end

Using the k8s_kubeconfig_get_with_http_info variant

This returns an Array which contains the response data, status code and headers.
<Array(String, Integer, Hash)> k8s_kubeconfig_get_with_http_info(k8s_cluster_id, opts)
begin
# Retrieve Kubernetes configuration files
data, status_code, headers = api_instance.k8s_kubeconfig_get_with_http_info(k8s_cluster_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => String
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_kubeconfig_get_with_http_info: #{e}"
end

Parameters

Name
Type
Description
Notes
k8s_cluster_id
String
The unique ID of the Kubernetes cluster.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

String

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, opts)
Delete Kubernetes node pools
Delete the specified Kubernetes node pool.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes node pool.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Delete Kubernetes node pools
api_instance.k8s_nodepools_delete(k8s_cluster_id, nodepool_id, opts)
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_delete: #{e}"
end

Using the k8s_nodepools_delete_with_http_info variant

This returns an Array which contains the response data (nil in this case), status code and headers.
<Array(nil, Integer, Hash)> k8s_nodepools_delete_with_http_info(k8s_cluster_id, nodepool_id, opts)
begin
# Delete Kubernetes node pools
data, status_code, headers = api_instance.k8s_nodepools_delete_with_http_info(k8s_cluster_id, nodepool_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => nil
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_delete_with_http_info: #{e}"
end

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 the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
[optional]

Return type

nil (empty response body)

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

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes node pool.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# Retrieve Kubernetes node pools
result = api_instance.k8s_nodepools_find_by_id(k8s_cluster_id, nodepool_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_find_by_id: #{e}"
end

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)
begin
# Retrieve Kubernetes node pools
data, status_code, headers = api_instance.k8s_nodepools_find_by_id_with_http_info(k8s_cluster_id, nodepool_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <KubernetesNodePool>
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_find_by_id_with_http_info: #{e}"
end

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 the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
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

k8s_nodepools_get(k8s_cluster_id, opts)
List Kubernetes node pools
List all Kubernetes node pools, included the specified Kubernetes cluster.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
opts = {
pretty: true, # Boolean | Controls whether the response is pretty-printed (with indentations and new lines).
depth: 56, # Integer | 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
x_contract_number: 56 # Integer | Users with multiple contracts must provide the contract number, for which all API requests are to be executed.
}
begin
# List Kubernetes node pools
result = api_instance.k8s_nodepools_get(k8s_cluster_id, opts)
p result
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_get: #{e}"
end

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)
begin
# List Kubernetes node pools
data, status_code, headers = api_instance.k8s_nodepools_get_with_http_info(k8s_cluster_id, opts)
p status_code # => 2xx
p headers # => { ... }
p data # => <KubernetesNodePools>
rescue Ionoscloud::ApiError => e
puts "Error when calling KubernetesApi->k8s_nodepools_get_with_http_info: #{e}"
end

Parameters

Name
Type
Description
Notes
k8s_cluster_id
String
The unique ID of the Kubernetes cluster.
pretty
Boolean
Controls whether the response is pretty-printed (with indentations and new lines).
[optional][default to true]
depth
Integer
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
Integer
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, opts)
Delete Kubernetes nodes
Delete the specified Kubernetes node.

Examples

require 'time'
require 'ionoscloud'
# setup authorization
Ionoscloud.configure do |config|
# Configure HTTP basic authorization: Basic Authentication
config.username = 'YOUR USERNAME'
config.password = 'YOUR PASSWORD'
# Configure API key authorization: Token Authentication
config.api_key['Authorization'] = 'YOUR API KEY'
# Uncomment the following line to set a prefix for the API key, e.g. 'Bearer' (defaults to nil)
# config.api_key_prefix['Authorization'] = 'Bearer'
end
api_instance = Ionoscloud::KubernetesApi.new
k8s_cluster_id = 'k8s_cluster_id_example' # String | The unique ID of the Kubernetes cluster.
nodepool_id = 'nodepool_id_example' # String | The unique ID of the Kubernetes node pool.
node_id = 'node_id_example' # String | The unique ID of the Kubernetes node.