KubernetesApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v6
Method | HTTP request | Description |
---|---|---|
Delete a Kubernetes Cluster by ID
Other parameters are passed through a pointer to a apiK8sDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Get a Kubernetes Cluster by ID
Other parameters are passed through a pointer to a apiK8sFindByClusterIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Get Kubernetes Clusters
Other parameters are passed through a pointer to a apiK8sGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Get Kubernetes Configuration File
Other parameters are passed through a pointer to a apiK8sKubeconfigGetRequest struct via the builder pattern
string
Content-Type: Not defined
Accept: application/yamlapplication/x-yamlapplication/json
Delete a Kubernetes Node Pool by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Get a Kubernetes Node Pool by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Get Kubernetes Node Pools
Other parameters are passed through a pointer to a apiK8sNodepoolsGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Delete a Kubernetes Node by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesDeleteRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Get Kubernetes Node by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Get Kubernetes Nodes
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Recreate a Kubernetes Node by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesReplacePostRequest struct via the builder pattern
(empty response body)
Content-Type: Not defined
Accept: application/json
Create a Kubernetes Node Pool
Other parameters are passed through a pointer to a apiK8sNodepoolsPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify a Kubernetes Node Pool by ID
Other parameters are passed through a pointer to a apiK8sNodepoolsPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Create a Kubernetes Cluster
Other parameters are passed through a pointer to a apiK8sPostRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Modify a Kubernetes Cluster by ID
Other parameters are passed through a pointer to a apiK8sPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Get Default Kubernetes Version
This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiK8sVersionsDefaultGetRequest struct via the builder pattern
string
Content-Type: Not defined
Accept: application/json
Get Kubernetes Versions
This endpoint does not need any parameter.
Other parameters are passed through a pointer to a apiK8sVersionsGetRequest struct via the builder pattern
[]string
Content-Type: Not defined
Accept: application/json
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
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
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the 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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the K8s cluster to be retrieved.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the 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.
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.
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.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the 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.
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.
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.
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.
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.
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.
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.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the Kubernetes cluster.
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.
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.
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.
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.
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the Kubernetes cluster.
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.