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

K8sDelete

Delete a Kubernetes Cluster by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

Other Parameters

Other parameters are passed through a pointer to an apiK8sDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sFindByClusterId

Get a Kubernetes Cluster by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the K8s cluster to be retrieved.

Other Parameters

Other parameters are passed through a pointer to an apiK8sFindByClusterIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sGet

Get Kubernetes Clusters

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to an apiK8sGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesClusters

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sKubeconfigGet

Get Kubernetes Configuration File

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

Other Parameters

Other parameters are passed through a pointer to an apiK8sKubeconfigGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/yamlapplication/x-yamlapplication/json

K8sNodepoolsDelete

Delete a Kubernetes Node Pool by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsFindById

Get a Kubernetes Node Pool by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsGet

Get Kubernetes Node Pools

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNodePools

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesDelete

Delete a Kubernetes Node by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

nodeId

string

The unique ID of the Kubernetes node.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsNodesDeleteRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesFindById

Get Kubernetes Node by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

nodeId

string

The unique ID of the Kubernetes node.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsNodesFindByIdRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNode

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesGet

Get Kubernetes Nodes

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsNodesGetRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNodes

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsNodesReplacePost

Recreate a Kubernetes Node by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

nodeId

string

The unique ID of the Kubernetes node.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsNodesReplacePostRequest struct via the builder pattern

Name
Type
Description
Notes

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

(empty response body)

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sNodepoolsPost

Create a Kubernetes Node Pool

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsPostRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesNodePool

The Kubernetes node pool to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sNodepoolsPut

Modify a Kubernetes Node Pool by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

nodepoolId

string

The unique ID of the Kubernetes node pool.

Other Parameters

Other parameters are passed through a pointer to an apiK8sNodepoolsPutRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesNodePool

Details of the Kubernetes Node Pool

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesNodePool

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sPost

Create a Kubernetes Cluster

Example

Path Parameters

Other Parameters

Other parameters are passed through a pointer to an apiK8sPostRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesCluster

The Kubernetes cluster to create.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sPut

Modify a Kubernetes Cluster by ID

Example

Path Parameters

Name
Type
Description
Notes

ctx

context.Context

context for authentication, logging, cancellation, deadlines, tracing, etc.

k8sClusterId

string

The unique ID of the Kubernetes cluster.

Other Parameters

Other parameters are passed through a pointer to an apiK8sPutRequest struct via the builder pattern

Name
Type
Description
Notes

kubernetesCluster

The modified Kubernetes cluster.

pretty

bool

Controls whether the response is pretty-printed (with indentations and new lines).

[default to true]

depth

int32

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

[default to 0]

xContractNumber

int32

Users with multiple contracts must provide the contract number, for which all API requests are to be executed.

Return type

KubernetesCluster

HTTP request headers

  • Content-Type: application/json

  • Accept: application/json

K8sVersionsDefaultGet

Get Default Kubernetes Version

Example

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to an apiK8sVersionsDefaultGetRequest struct via the builder pattern

Return type

string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

K8sVersionsGet

Get Kubernetes Versions

Example

Path Parameters

This endpoint does not need any parameter.

Other Parameters

Other parameters are passed through a pointer to an apiK8sVersionsGetRequest struct via the builder pattern

Return type

[]string

HTTP request headers

  • Content-Type: Not defined

  • Accept: application/json

Last updated