Kubernetes

IONOS Cloud Managed Kubernetes (K8s) consist of two central building blocks:

First, the Kubernetes cluster provides the control plane, although it is not directly visible.

Second, the node pools provide the worker nodes. While these are visible in a VDC, as Kubernetes is built on top of the compute engine, i.e., servers, volumes, etc.

Get Kubernetes Clusters

get

Retrieves a list of all K8s clusters provisioned under your account.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "k8s",
  "type": "collection",
  "href": "https://api.ionos.com/cloudapi/v6/k8s",
  "items": [
    {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
      "type": "k8s",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/b0a6ed23-0636-4bd4-94aa-be01c355af1d",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "k8s",
        "k8sVersion": "1.15.4",
        "maintenanceWindow": {
          "dayOfTheWeek": "Monday",
          "time": "13:00:00"
        },
        "availableUpgradeVersions": [
          "1.16.4",
          "1.17.7"
        ],
        "viableNodePoolVersions": [
          "1.17.7",
          "1.18.2"
        ],
        "public": true,
        "location": "de/fra",
        "natGatewayIp": "198.51.100.100",
        "nodeSubnet": "192.168.0.0/16",
        "apiSubnetAllowList": [
          "1.2.3.4/32",
          "2002::1234:abcd:ffff:c0a8:101/64",
          "1.2.3.4",
          "2002::1234:abcd:ffff:c0a8:101"
        ],
        "s3Buckets": [
          {
            "name": "My Bucket"
          }
        ]
      },
      "entities": {
        "nodepools": {
          "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
          "type": "collection",
          "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
          "items": [
            {
              "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
              "type": "nodepool",
              "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
              "metadata": {
                "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
                "createdDate": "2015-12-04T14:34:09.809Z",
                "createdBy": "[email protected]",
                "createdByUserId": "[email protected]",
                "lastModifiedDate": "2015-12-04T14:34:09.809Z",
                "lastModifiedBy": "[email protected]",
                "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
                "state": "AVAILABLE"
              },
              "properties": {
                "name": "K8s-node-pool",
                "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
                "nodeCount": 2,
                "serverType": "DedicatedCore",
                "coresCount": 4,
                "ramSize": 2048,
                "availabilityZone": "AUTO",
                "storageType": "HDD",
                "storageSize": 100,
                "k8sVersion": "1.15.4",
                "maintenanceWindow": {
                  "dayOfTheWeek": "Monday",
                  "time": "13:00:00"
                },
                "autoScaling": {
                  "minNodeCount": 1,
                  "maxNodeCount": 3
                },
                "lans": [
                  {
                    "datacenterId": "00000000-0000-0000-0000-000000000000",
                    "id": 3,
                    "dhcp": true,
                    "routes": [
                      {
                        "network": "1.2.3.4/24",
                        "gatewayIp": "10.1.5.16"
                      }
                    ]
                  }
                ],
                "labels": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "annotations": {
                  "ANY_ADDITIONAL_PROPERTY": "text"
                },
                "publicIps": [
                  "81.173.1.2",
                  "82.231.2.5",
                  "92.221.2.4"
                ],
                "availableUpgradeVersions": [
                  "1.16.4",
                  "1.17.7"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}

Create a Kubernetes Cluster

post

Creates a K8s cluster provisioned under your account.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Body

application/json

idstringRead-onlyOptional

The resource unique identifier.

Example: 1e072e52-2ed3-492f-b6b6-c6b116907527

typestring · enumRead-onlyOptional

The object type.

Possible values:

hrefstring · uriRead-onlyOptional

The URL to the object representation (absolute path).

Example: https://api.ionos.com/cloudapi/v6/k8s/cc536834-b436-4b8e-b7d9-1e1473080057

Responses

202

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

post

/k8s

HTTPcURLJavaScriptPython

POST /cloudapi/v6/k8s HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 401

{
  "metadata": {},
  "properties": {
    "name": "k8s",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "public": true,
    "location": "de/fra",
    "natGatewayIp": "198.51.100.100",
    "nodeSubnet": "192.168.0.0/16",
    "apiSubnetAllowList": [
      "1.2.3.4/32",
      "2002::1234:abcd:ffff:c0a8:101/64",
      "1.2.3.4",
      "2002::1234:abcd:ffff:c0a8:101"
    ],
    "s3Buckets": [
      {
        "name": "My Bucket"
      }
    ]
  },
  "entities": {
    "nodepools": {}
  }
}

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "k8s",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/b0a6ed23-0636-4bd4-94aa-be01c355af1d",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "k8s",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ],
    "viableNodePoolVersions": [
      "1.17.7",
      "1.18.2"
    ],
    "public": true,
    "location": "de/fra",
    "natGatewayIp": "198.51.100.100",
    "nodeSubnet": "192.168.0.0/16",
    "apiSubnetAllowList": [
      "1.2.3.4/32",
      "2002::1234:abcd:ffff:c0a8:101/64",
      "1.2.3.4",
      "2002::1234:abcd:ffff:c0a8:101"
    ],
    "s3Buckets": [
      {
        "name": "My Bucket"
      }
    ]
  },
  "entities": {
    "nodepools": {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
      "items": [
        {
          "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
          "type": "nodepool",
          "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "K8s-node-pool",
            "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
            "nodeCount": 2,
            "serverType": "DedicatedCore",
            "coresCount": 4,
            "ramSize": 2048,
            "availabilityZone": "AUTO",
            "storageType": "HDD",
            "storageSize": 100,
            "k8sVersion": "1.15.4",
            "maintenanceWindow": {
              "dayOfTheWeek": "Monday",
              "time": "13:00:00"
            },
            "autoScaling": {
              "minNodeCount": 1,
              "maxNodeCount": 3
            },
            "lans": [
              {
                "datacenterId": "00000000-0000-0000-0000-000000000000",
                "id": 3,
                "dhcp": true,
                "routes": [
                  {
                    "network": "1.2.3.4/24",
                    "gatewayIp": "10.1.5.16"
                  }
                ]
              }
            ],
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "annotations": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "publicIps": [
              "81.173.1.2",
              "82.231.2.5",
              "92.221.2.4"
            ],
            "availableUpgradeVersions": [
              "1.16.4",
              "1.17.7"
            ]
          }
        }
      ]
    }
  }
}

Get a Kubernetes Cluster by ID

get

Retrieves the K8s cluster specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the K8s cluster to be retrieved.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s/{k8sClusterId}

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "k8s",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/b0a6ed23-0636-4bd4-94aa-be01c355af1d",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "k8s",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ],
    "viableNodePoolVersions": [
      "1.17.7",
      "1.18.2"
    ],
    "public": true,
    "location": "de/fra",
    "natGatewayIp": "198.51.100.100",
    "nodeSubnet": "192.168.0.0/16",
    "apiSubnetAllowList": [
      "1.2.3.4/32",
      "2002::1234:abcd:ffff:c0a8:101/64",
      "1.2.3.4",
      "2002::1234:abcd:ffff:c0a8:101"
    ],
    "s3Buckets": [
      {
        "name": "My Bucket"
      }
    ]
  },
  "entities": {
    "nodepools": {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
      "items": [
        {
          "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
          "type": "nodepool",
          "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "K8s-node-pool",
            "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
            "nodeCount": 2,
            "serverType": "DedicatedCore",
            "coresCount": 4,
            "ramSize": 2048,
            "availabilityZone": "AUTO",
            "storageType": "HDD",
            "storageSize": 100,
            "k8sVersion": "1.15.4",
            "maintenanceWindow": {
              "dayOfTheWeek": "Monday",
              "time": "13:00:00"
            },
            "autoScaling": {
              "minNodeCount": 1,
              "maxNodeCount": 3
            },
            "lans": [
              {
                "datacenterId": "00000000-0000-0000-0000-000000000000",
                "id": 3,
                "dhcp": true,
                "routes": [
                  {
                    "network": "1.2.3.4/24",
                    "gatewayIp": "10.1.5.16"
                  }
                ]
              }
            ],
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "annotations": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "publicIps": [
              "81.173.1.2",
              "82.231.2.5",
              "92.221.2.4"
            ],
            "availableUpgradeVersions": [
              "1.16.4",
              "1.17.7"
            ]
          }
        }
      ]
    }
  }
}

Modify a Kubernetes Cluster by ID

put

Modifies the K8s cluster specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Body

application/json

idstringRead-onlyOptional

The resource's unique identifier.

Example: 1e072e52-2ed3-492f-b6b6-c6b116907527

typestring · enumRead-onlyOptional

The type of object.

Possible values:

hrefstring · uriRead-onlyOptional

URL to the object representation (absolute path).

Example: <RESOURCE-URI>

Responses

202

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

put

/k8s/{k8sClusterId}

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/k8s/{k8sClusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 305

{
  "metadata": {},
  "properties": {
    "name": "k8s",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "apiSubnetAllowList": [
      "1.2.3.4/32",
      "2002::1234:abcd:ffff:c0a8:101/64",
      "1.2.3.4",
      "2002::1234:abcd:ffff:c0a8:101"
    ],
    "s3Buckets": [
      {
        "name": "My Bucket"
      }
    ]
  },
  "entities": {
    "nodepools": {}
  }
}

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "k8s",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/b0a6ed23-0636-4bd4-94aa-be01c355af1d",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "k8s",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ],
    "viableNodePoolVersions": [
      "1.17.7",
      "1.18.2"
    ],
    "public": true,
    "location": "de/fra",
    "natGatewayIp": "198.51.100.100",
    "nodeSubnet": "192.168.0.0/16",
    "apiSubnetAllowList": [
      "1.2.3.4/32",
      "2002::1234:abcd:ffff:c0a8:101/64",
      "1.2.3.4",
      "2002::1234:abcd:ffff:c0a8:101"
    ],
    "s3Buckets": [
      {
        "name": "My Bucket"
      }
    ]
  },
  "entities": {
    "nodepools": {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
      "type": "collection",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
      "items": [
        {
          "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
          "type": "nodepool",
          "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
          "metadata": {
            "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
            "createdDate": "2015-12-04T14:34:09.809Z",
            "createdBy": "[email protected]",
            "createdByUserId": "[email protected]",
            "lastModifiedDate": "2015-12-04T14:34:09.809Z",
            "lastModifiedBy": "[email protected]",
            "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
            "state": "AVAILABLE"
          },
          "properties": {
            "name": "K8s-node-pool",
            "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
            "nodeCount": 2,
            "serverType": "DedicatedCore",
            "coresCount": 4,
            "ramSize": 2048,
            "availabilityZone": "AUTO",
            "storageType": "HDD",
            "storageSize": 100,
            "k8sVersion": "1.15.4",
            "maintenanceWindow": {
              "dayOfTheWeek": "Monday",
              "time": "13:00:00"
            },
            "autoScaling": {
              "minNodeCount": 1,
              "maxNodeCount": 3
            },
            "lans": [
              {
                "datacenterId": "00000000-0000-0000-0000-000000000000",
                "id": 3,
                "dhcp": true,
                "routes": [
                  {
                    "network": "1.2.3.4/24",
                    "gatewayIp": "10.1.5.16"
                  }
                ]
              }
            ],
            "labels": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "annotations": {
              "ANY_ADDITIONAL_PROPERTY": "text"
            },
            "publicIps": [
              "81.173.1.2",
              "82.231.2.5",
              "92.221.2.4"
            ],
            "availableUpgradeVersions": [
              "1.16.4",
              "1.17.7"
            ]
          }
        }
      ]
    }
  }
}

Delete a Kubernetes Cluster by ID

delete

Deletes the K8s cluster specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

202

Successful operation

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

delete

/k8s/{k8sClusterId}

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/k8s/{k8sClusterId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Get Kubernetes Configuration File

get

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.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/yamlapplication/x-yamlapplication/json

Responsestring

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/yamlapplication/x-yamlapplication/json

get

/k8s/{k8sClusterId}/kubeconfig

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId}/kubeconfig HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

text

Get Kubernetes Node Pools

get

Retrieves a list of K8s node pools of a cluster specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s/{k8sClusterId}/nodepools

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId}/nodepools HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
  "type": "collection",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools",
  "items": [
    {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
      "type": "nodepool",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "createdBy": "[email protected]",
        "createdByUserId": "[email protected]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[email protected]",
        "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
        "state": "AVAILABLE"
      },
      "properties": {
        "name": "K8s-node-pool",
        "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
        "nodeCount": 2,
        "serverType": "DedicatedCore",
        "coresCount": 4,
        "ramSize": 2048,
        "availabilityZone": "AUTO",
        "storageType": "HDD",
        "storageSize": 100,
        "k8sVersion": "1.15.4",
        "maintenanceWindow": {
          "dayOfTheWeek": "Monday",
          "time": "13:00:00"
        },
        "autoScaling": {
          "minNodeCount": 1,
          "maxNodeCount": 3
        },
        "lans": [
          {
            "datacenterId": "00000000-0000-0000-0000-000000000000",
            "id": 3,
            "dhcp": true,
            "routes": [
              {
                "network": "1.2.3.4/24",
                "gatewayIp": "10.1.5.16"
              }
            ]
          }
        ],
        "labels": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "annotations": {
          "ANY_ADDITIONAL_PROPERTY": "text"
        },
        "publicIps": [
          "81.173.1.2",
          "82.231.2.5",
          "92.221.2.4"
        ],
        "availableUpgradeVersions": [
          "1.16.4",
          "1.17.7"
        ]
      }
    }
  ]
}

Create a Kubernetes Node Pool

post

Creates a node pool inside the specified K8s cluster.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Body

application/json

idstringRead-onlyOptional

The resource's unique identifier.

Example: 1e072e52-2ed3-492f-b6b6-c6b116907527

typestring · enumRead-onlyOptional

The object type.

Possible values:

hrefstring · uriRead-onlyOptional

The URL to the object representation (absolute path).

Example: https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038

Responses

202

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

post

/k8s/{k8sClusterId}/nodepools

HTTPcURLJavaScriptPython

POST /cloudapi/v6/k8s/{k8sClusterId}/nodepools HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 670

{
  "metadata": {},
  "properties": {
    "name": "K8s-node-pool",
    "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
    "nodeCount": 2,
    "serverType": "DedicatedCore",
    "coresCount": 4,
    "ramSize": 2048,
    "availabilityZone": "AUTO",
    "storageType": "HDD",
    "storageSize": 100,
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 3
    },
    "lans": [
      {
        "datacenterId": "00000000-0000-0000-0000-000000000000",
        "id": 3,
        "dhcp": true,
        "routes": [
          {
            "network": "1.2.3.4/24",
            "gatewayIp": "10.1.5.16"
          }
        ]
      }
    ],
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicIps": [
      "81.173.1.2",
      "82.231.2.5",
      "92.221.2.4"
    ]
  }
}

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "nodepool",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "K8s-node-pool",
    "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
    "nodeCount": 2,
    "serverType": "DedicatedCore",
    "coresCount": 4,
    "ramSize": 2048,
    "availabilityZone": "AUTO",
    "storageType": "HDD",
    "storageSize": 100,
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 3
    },
    "lans": [
      {
        "datacenterId": "00000000-0000-0000-0000-000000000000",
        "id": 3,
        "dhcp": true,
        "routes": [
          {
            "network": "1.2.3.4/24",
            "gatewayIp": "10.1.5.16"
          }
        ]
      }
    ],
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicIps": [
      "81.173.1.2",
      "82.231.2.5",
      "92.221.2.4"
    ],
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ]
  }
}

Get a Kubernetes Node Pool by ID

get

Retrieves the K8s node pool specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s/{k8sClusterId}/nodepools/{nodepoolId}

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "nodepool",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "K8s-node-pool",
    "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
    "nodeCount": 2,
    "serverType": "DedicatedCore",
    "coresCount": 4,
    "ramSize": 2048,
    "availabilityZone": "AUTO",
    "storageType": "HDD",
    "storageSize": 100,
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 3
    },
    "lans": [
      {
        "datacenterId": "00000000-0000-0000-0000-000000000000",
        "id": 3,
        "dhcp": true,
        "routes": [
          {
            "network": "1.2.3.4/24",
            "gatewayIp": "10.1.5.16"
          }
        ]
      }
    ],
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicIps": [
      "81.173.1.2",
      "82.231.2.5",
      "92.221.2.4"
    ],
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ]
  }
}

Modify a Kubernetes Node Pool by ID

put

Modifies the K8s node pool specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Body

application/json

idstringRead-onlyOptional

The resource's unique identifier.

Example: 1e072e52-2ed3-492f-b6b6-c6b116907527

typestring · enumRead-onlyOptional

The object type.

Possible values:

hrefstring · uriRead-onlyOptional

The URL to the object representation (absolute path).

Example: https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038

Responses

202

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

put

/k8s/{k8sClusterId}/nodepools/{nodepoolId}

HTTPcURLJavaScriptPython

PUT /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 522

{
  "metadata": {},
  "properties": {
    "name": "k8s-node-pool",
    "nodeCount": 2,
    "serverType": "DedicatedCore",
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 3
    },
    "lans": [
      {
        "datacenterId": "00000000-0000-0000-0000-000000000000",
        "id": 3,
        "dhcp": true,
        "routes": [
          {
            "network": "1.2.3.4/24",
            "gatewayIp": "10.1.5.16"
          }
        ]
      }
    ],
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicIps": [
      "81.173.1.2",
      "82.231.2.5",
      "92.221.2.4"
    ]
  }
}

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "nodepool",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/4735f530-4279-42f3-9562-386143098038",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "createdBy": "[email protected]",
    "createdByUserId": "[email protected]",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedBy": "[email protected]",
    "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
    "state": "AVAILABLE"
  },
  "properties": {
    "name": "K8s-node-pool",
    "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
    "nodeCount": 2,
    "serverType": "DedicatedCore",
    "coresCount": 4,
    "ramSize": 2048,
    "availabilityZone": "AUTO",
    "storageType": "HDD",
    "storageSize": 100,
    "k8sVersion": "1.15.4",
    "maintenanceWindow": {
      "dayOfTheWeek": "Monday",
      "time": "13:00:00"
    },
    "autoScaling": {
      "minNodeCount": 1,
      "maxNodeCount": 3
    },
    "lans": [
      {
        "datacenterId": "00000000-0000-0000-0000-000000000000",
        "id": 3,
        "dhcp": true,
        "routes": [
          {
            "network": "1.2.3.4/24",
            "gatewayIp": "10.1.5.16"
          }
        ]
      }
    ],
    "labels": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "annotations": {
      "ANY_ADDITIONAL_PROPERTY": "text"
    },
    "publicIps": [
      "81.173.1.2",
      "82.231.2.5",
      "92.221.2.4"
    ],
    "availableUpgradeVersions": [
      "1.16.4",
      "1.17.7"
    ]
  }
}

Delete a Kubernetes Node Pool by ID

delete

Deletes the K8s node pool specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

202

Successful operation

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

delete

/k8s/{k8sClusterId}/nodepools/{nodepoolId}

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Get Kubernetes Nodes

get

Retrieves the list of all K8s nodes of the specified node pool.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527/nodepools",
  "type": "collection",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/bfdf67bd-5665-4245-8096-7c7991f02f3f/nodes",
  "items": [
    {
      "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
      "type": "node",
      "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/bfdf67bd-5665-4245-8096-7c7991f02f3f/nodes/81892fdb-d97e-4919-baf9-2b3a923f5401",
      "metadata": {
        "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
        "createdDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "state": "READY",
        "lastSoftwareUpdatedDate": "2015-12-04T14:34:09.809Z"
      },
      "properties": {
        "name": "K8s-node",
        "publicIP": "192.168.23.2",
        "privateIP": "192.168.23.2",
        "k8sVersion": "1.15.4"
      }
    }
  ]
}

Get Kubernetes Node by ID

get

Retrieves the K8s node specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

nodeIdstringRequired

The unique ID of the Kubernetes node.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

200

Successful operation

application/json

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

get

/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

{
  "id": "1e072e52-2ed3-492f-b6b6-c6b116907527",
  "type": "node",
  "href": "https://api.ionos.com/cloudapi/v6/k8s/30f8a4f6-6515-4c34-b49d-dea807453b90/nodepools/bfdf67bd-5665-4245-8096-7c7991f02f3f/nodes/81892fdb-d97e-4919-baf9-2b3a923f5401",
  "metadata": {
    "etag": "45480eb3fbfc31f1d916c1eaa4abdcc3",
    "createdDate": "2015-12-04T14:34:09.809Z",
    "lastModifiedDate": "2015-12-04T14:34:09.809Z",
    "state": "READY",
    "lastSoftwareUpdatedDate": "2015-12-04T14:34:09.809Z"
  },
  "properties": {
    "name": "K8s-node",
    "publicIP": "192.168.23.2",
    "privateIP": "192.168.23.2",
    "k8sVersion": "1.15.4"
  }
}

Delete a Kubernetes Node by ID

delete

Deletes the K8s node specified by its ID.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

nodeIdstringRequired

The unique ID of the Kubernetes node.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

202

Successful operation

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

delete

/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}

HTTPcURLJavaScriptPython

DELETE /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId} HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Recreate a Kubernetes Node by ID

post

Recreates the K8s node specified by its ID.

If a node becomes unusable, Managed Kubernetes allows you to recreate it with a configuration based on the node pool template. Once the status is 'Active,' all the pods from the failed node will be migrated to the new node. The node pool has an additional billable 'active' node during this process.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Path parameters

k8sClusterIdstringRequired

The unique ID of the Kubernetes cluster.

nodepoolIdstringRequired

The unique ID of the Kubernetes node pool.

nodeIdstringRequired

The unique ID of the Kubernetes node.

Query parameters

prettybooleanOptional

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

Default: true

depthinteger · int32 · max: 10Optional

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: 0

Header parameters

X-Contract-Numberinteger · int32Optional

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

Responses

202

Successful operation

default

Any erroneous status code: 400 (parse error), 401 (auth error), 402 (trial access), 403 (insufficient privileges), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type, 422 (validation error), 429 (request rate limit exceeded), 500 (server error), or 503 (maintenance).

application/json

post

/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace

HTTPcURLJavaScriptPython

POST /cloudapi/v6/k8s/{k8sClusterId}/nodepools/{nodepoolId}/nodes/{nodeId}/replace HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

No content

Get Kubernetes Versions

get

Lists available K8s versions.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Responses

200

Successful operation

application/json

Responsestring[]

default

Any erroneous status code: 401 (auth error), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 500 (server error), 503 (maintenance)

application/json

get

/k8s/versions

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/versions HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

[
  "text"
]

Get Default Kubernetes Version

get

Retrieves the current default K8s version to be used by the clusters and node pools.

Authorizations

BasicAuthenticationTokenAuthentication

AuthorizationstringRequired

You will need to base64 encode the string containing your credentials. Note:

Responses

200

Successful operation

application/json

ResponsestringExample: 1.21.4

default

Any erroneous status code: 401 (auth error), 404 (not found), 405 (unsupported HTTP method), 415 (unsupported content type), 422 (validation error), 500 (server error), 503 (maintenance)

application/json

get

/k8s/versions/default

HTTPcURLJavaScriptPython

GET /cloudapi/v6/k8s/versions/default HTTP/1.1
Host: api.ionos.com
Authorization: Basic username:password
Accept: */*

1.21.4