Get Kubernetes Clusters

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

get

Authorizations

AuthorizationstringRequired

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

Note:

• Basic Authentication is supported only when 2-Factor Authentication is not configured.
• Users with 2-Factor Authentication activated must generate new 2FA-secured tokens in the DCD using [Token Manager](https://docs.ionos.com/cloud/set-up-ionos-cloud/management/identity-access-management/token-manager). These tokens do not inherit the 2FA-secured property by default.
• Token deletion is only possible using the Token Manager.

Separate your username and password with a colon, i.e., username:password and send it as 'Authorization' request header. More details: https://en.wikipedia.org/wiki/Basic_access_authentication

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

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": "[e-mail]",
        "createdByUserId": "[e-mail]",
        "lastModifiedDate": "2015-12-04T14:34:09.809Z",
        "lastModifiedBy": "[e-mail]",
        "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": "[e-mail]",
                "createdByUserId": "[e-mail]",
                "lastModifiedDate": "2015-12-04T14:34:09.809Z",
                "lastModifiedBy": "[e-mail]",
                "lastModifiedByUserId": "63cef532-26fe-4a64-a4e0-de7c8a506c90",
                "state": "AVAILABLE"
              },
              "properties": {
                "name": "K8s-node-pool",
                "datacenterId": "1e072e52-2ed3-492f-b6b6-c6b116907521",
                "nodeCount": 2,
                "serverType": "DedicatedCore",
                "templateUuid": "1e072e52-2ed3-492f-b6b6-c6b116907521",
                "coresCount": 4,
                "ramSize": 2048,
                "availabilityZone": "AUTO",
                "storageType": "PERFORMANCE",
                "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"
                },
                "taints": [
                  {
                    "key": "dedicated",
                    "value": "gpu-workloads",
                    "effect": "NoSchedule"
                  }
                ],
                "publicIps": [
                  "81.173.1.2",
                  "82.231.2.5",
                  "92.221.2.4"
                ],
                "availableUpgradeVersions": [
                  "1.16.4",
                  "1.17.7"
                ]
              }
            }
          ]
        }
      }
    }
  ]
}