KubernetesApi
Last updated
Last updated
All URIs are relative to https://api.ionos.com/cloudapi/v5
Method | HTTP request | Description |
---|---|---|
Delete Kubernetes Cluster
Other parameters are passed through a pointer to a apiK8sDeleteRequest struct via the builder pattern
map[string]interface{}
Content-Type: Not defined
Accept: application/json
Retrieve Kubernetes Cluster
Other parameters are passed through a pointer to a apiK8sFindByClusterIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List Kubernetes Clusters
Other parameters are passed through a pointer to a apiK8sGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve Kubernetes Configuration File
Other parameters are passed through a pointer to a apiK8sKubeconfigGetRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Delete Kubernetes Node Pool
Other parameters are passed through a pointer to a apiK8sNodepoolsDeleteRequest struct via the builder pattern
map[string]interface{}
Content-Type: Not defined
Accept: application/json
Retrieve Kubernetes Node Pool
Other parameters are passed through a pointer to a apiK8sNodepoolsFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
List 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 Kubernetes node
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesDeleteRequest struct via the builder pattern
map[string]interface{}
Content-Type: Not defined
Accept: application/json
Retrieve Kubernetes node
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesFindByIdRequest struct via the builder pattern
Content-Type: Not defined
Accept: application/json
Retrieve 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 the Kubernetes node
Other parameters are passed through a pointer to a apiK8sNodepoolsNodesReplacePostRequest struct via the builder pattern
map[string]interface{}
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 Kubernetes Node Pool
Other parameters are passed through a pointer to a apiK8sNodepoolsPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Create 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 Kubernetes Cluster
Other parameters are passed through a pointer to a apiK8sPutRequest struct via the builder pattern
Content-Type: application/json
Accept: application/json
Retrieves a list of available kubernetes versions for nodepools depending on the given kubernetes version running in the cluster.
Other parameters are passed through a pointer to a apiK8sVersionsCompatibilitiesGetRequest struct via the builder pattern
[]string
Content-Type: Not defined
Accept: application/json
Retrieve the current default kubernetes version for clusters and nodepools.
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
Retrieve available 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 |
---|---|---|---|
Name | Type | Description | Notes |
---|---|---|---|
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
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the Kubernetes Cluster
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the Kubernetes Cluster
kubernetesNodePool
Details of the Kubernetes Node Pool
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should 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 response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
kubernetesCluster
Details of the Kubernetes Cluster
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
k8sClusterId
string
The unique ID of the Kubernetes Cluster
kubernetesCluster
Details of the Kubernetes Cluster
pretty
bool
Controls whether response is pretty-printed (with indentation and new lines)
[default to true]
depth
int32
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
[default to 0]
xContractNumber
int32
Users having more than 1 contract need to provide contract number, against which all API requests should be executed
ctx
context.Context
context for authentication, logging, cancellation, deadlines, tracing, etc.
clusterVersion
string