Linode Kubernetes Engine (LKE)

List Node Pools

get
https://api.linode.com/v4/lke/clusters/{clusterId}/pools

Returns all active Node Pools on a Kubernetes cluster.

Authorizations

Personal Access Token
OAuth: ( lke:read_only)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

Request Samples

curl -H "Authorization: Bearer $TOKEN" \
      https://api.linode.com/v4/lke/clusters/12345/pools

Response Samples

{
  "data": [
    {
      "id": "",
      "nodes": []
    }
  ],
  "page": 1,
  "pages": 1,
  "results": 1
}

Responses

200: Returns an array of all Pools in this Kubernetes cluster.

data
array of objects
id
Filterable
integer

This Node Pool's unique ID.

nodes
array

Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.

type
string

A Linode Type for all of the nodes in the Node Pool.

count
integer

The number of nodes in the Node Pool.

disks
array

This Node Pool's custom disk layout. Each item in this array will create a new disk partition for each node in this Node Pool.

  • The custom disk layout is applied to each node in this Node Pool.
  • The maximum number of custom disk partitions that can be configured is 7.
  • Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
  • A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.

Note: If this field is omitted, the node will have a default disk layout consisting of a single partition. A custom layout is only required for specific use cases.

page
integer
pages
integer
results
integer

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.

Create Node Pool

post
https://api.linode.com/v4/lke/clusters/{clusterId}/pools

Creates a new Node Pool for the designated Kubernetes cluster.

Authorizations

Personal Access Token
OAuth: ( lke:read_write)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

Request Body Schema

count
Required
integer

The number of nodes in the Node Pool.

type
Required
string

A Linode Type for all of the nodes in the Node Pool.

disks
array

This Node Pool's custom disk layout. Each item in this array will create a new disk partition for each node in this Node Pool.

  • The custom disk layout is applied to each node in this Node Pool.
  • The maximum number of custom disk partitions that can be configured is 7.
  • Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
  • A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.

Note: If this field is omitted, the node will have a default disk layout consisting of a single partition. A custom layout is only required for specific use cases.

Request Samples

curl -H "Content-Type: application/json" \
      -H "Authorization: Bearer $TOKEN" \
      -X POST -d '{
        "type": "g6-standard-4",
        "count": 6,
        "disks": [
              {
                "size": 1028,
                "type": "ext4"
              }
            ]
      }' \
      https://api.linode.com/v4/lke/clusters/12345/pools

Response Samples

{
  "id": 1234,
  "type": "g6-standard-4",
  "disks": [
    {
      "size": 1024,
      "type": "ext-4"
    }
  ],
  "count": 6,
  "nodes": [
    {
      "id": "123456",
      "instance_id": 123458,
      "status": "ready"
    }
  ]
}

Responses

200: Node Pool has been created.

id
Filterable
integer

This Node Pool's unique ID.

type
string

A Linode Type for all of the nodes in the Node Pool.

disks
array of objects

This Node Pool's custom disk layout. Each item in this array will create a new disk partition for each node in this Node Pool.

  • The custom disk layout is applied to each node in this Node Pool.
  • The maximum number of custom disk partitions that can be configured is 7.
  • Once the requested disk paritions are allocated, the remaining disk space is allocated to the node's boot disk.
  • A Node Pool's custom disk layout is immutable over the lifetime of the Node Pool.

Note: If this field is omitted, the node will have a default disk layout consisting of a single partition. A custom layout is only required for specific use cases.

size
integer

The size of this custom disk partition in MB.

  • The size of this disk partition must not exceed the capacity of the node's plan type.
type
string
Enum: "raw""ext4"

This custom disk partition's filesystem type.

count
integer

The number of nodes in the Node Pool.

nodes
array of objects

Status information for the Nodes which are members of this Node Pool. If a Linode has not been provisioned for a given Node slot, the instance_id will be returned as null.

id
string

The Node's ID.

instance_id
string

The Linode's ID. When no Linode is currently provisioned for this Node, this will be null.

status
string
Enum: "ready""not_ready"

The Node's status as it pertains to being a Kubernetes node.

default: Error

errors
array of objects
reason
string

What happened to cause this error. In most cases, this can be fixed immediately by changing the data you sent in the request, but in some cases you will be instructed to open a Support Ticket or perform some other action before you can complete the request successfully.

field
string

The field in the request that caused this error. This may be a path, separated by periods in the case of nested fields. In some cases this may come back as "null" if the error is not specific to any single element of the request.