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(k8sClusterId, opts)
Delete a Kubernetes Cluster by ID
Deletes the K8s cluster specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Delete a Kubernetes Cluster by ID
api_instance
.k8sDelete({
k8sClusterId: k8sClusterId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sFindByClusterId(k8sClusterId, opts)
Get a Kubernetes Cluster by ID
Retrieves the K8s cluster specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Get a Kubernetes Cluster by ID
api_instance
.k8sFindByClusterId({
k8sClusterId: k8sClusterId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the K8s cluster to be retrieved. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sGet(opts)
Get Kubernetes Clusters
Retrieves a list of all K8s clusters provisioned under your account.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Clusters
api_instance
.k8sGet({
pretty: true,
depth: 56,
xContractNumber: 56
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
string k8sKubeconfigGet(k8sClusterId, opts)
Get Kubernetes Configuration File
Retrieves the configuration file for the specified K8s cluster. You can define the format (YAML or JSON) of the returned file in the Accept header. By default, 'application/yaml' is specified.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Configuration File
api_instance
.k8sKubeconfigGet({
k8sClusterId: k8sClusterId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
string
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/yaml, application/x-yaml, application/json
k8sNodepoolsDelete(k8sClusterId, nodepoolId, opts)
Delete a Kubernetes Node Pool by ID
Deletes the K8s node pool specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Delete a Kubernetes Node Pool by ID
api_instance
.k8sNodepoolsDelete({
k8sClusterId: k8sClusterId_example,
nodepoolId: nodepoolId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
nodepoolId | string | The unique ID of the Kubernetes node pool. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sNodepoolsFindById(k8sClusterId, nodepoolId, opts)
Get a Kubernetes Node Pool by ID
Retrieves the K8s node pool specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Get a Kubernetes Node Pool by ID
api_instance
.k8sNodepoolsFindById({
k8sClusterId: k8sClusterId_example,
nodepoolId: nodepoolId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
nodepoolId | string | The unique ID of the Kubernetes node pool. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sNodepoolsGet(k8sClusterId, opts)
Get Kubernetes Node Pools
Retrieves a list of K8s node pools of a cluster specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
var filterMap = new Map()
filterMap.set("<property_name>", "<property_value>")
// Get Kubernetes Node Pools
api_instance
.k8sNodepoolsGet({
k8sClusterId: k8sClusterId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
orderBy: "<property_name>"
maxResults: 2,
filters: filterMap
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sNodepoolsNodesDelete(k8sClusterId, nodepoolId, nodeId, opts)
Delete a Kubernetes Node by ID
Deletes the K8s node specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Delete a Kubernetes Node by ID
api_instance
.k8sNodepoolsNodesDelete({
k8sClusterId: k8sClusterId_example,
nodepoolId: nodepoolId_example,
nodeId: nodeId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
nodepoolId | string | The unique ID of the Kubernetes node pool. | [default to undefined] |
nodeId | string | The unique ID of the Kubernetes node. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber | number | Users with multiple contracts must provide the contract number, for which all API requests are to be executed. | [optional][default to undefined] |
nil (empty response body)
Basic Authentication, Token Authentication
- Content-Type: Not defined
- Accept: application/json
k8sNodepoolsNodesFindById(k8sClusterId, nodepoolId, nodeId, opts)
Get Kubernetes Node by ID
Retrieves the K8s node specified by its ID.
const ionoscloud = require('@ionos-cloud/sdk-nodejs');
// setup authorization
const config = new ionoscloud.Configuration({
username: 'YOUR_USERNAME',
password: 'YOUR_PASSWORD',
apiKey: 'YOUR_API_KEY'
});
const api_instance = new ionoscloud.KubernetesApi(config);
// Get Kubernetes Node by ID
api_instance
.k8sNodepoolsNodesFindById({
k8sClusterId: k8sClusterId_example,
nodepoolId: nodepoolId_example,
nodeId: nodeId_example,
pretty: true,
depth: 56,
xContractNumber: 56,
options: {}
})
.then((response) => console.log(response.data))
.catch((error) => console.log(error.response.data));
Name | Type | Description | Notes |
---|---|---|---|
k8sClusterId | string | The unique ID of the Kubernetes cluster. | [default to undefined] |
nodepoolId | string | The unique ID of the Kubernetes node pool. | [default to undefined] |
nodeId | string | The unique ID of the Kubernetes node. | [default to undefined] |
pretty | boolean | Controls whether the response is pretty-printed (with indentations and new lines). | [optional][default to true] |
depth | number | 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] |
xContractNumber |