Linode Kubernetes Engine (LKE)

View Node Pool

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

Get a specific Node Pool by ID.

Authorizations

Personal Access Token
OAuth: ( lke:read_only)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

poolId
Required
integer

ID of the Pool to look up

Request Samples

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

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: Returns the requested Node Pool.

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.

Update Node Pool

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

Updates a Node Pool. When a Node Pool's count are changed, the nodes in that pool will be replaced in a rolling fashion.

Authorizations

Personal Access Token
OAuth: ( lke:read_write)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

poolId
Required
integer

ID of the Pool to look up

Request Body Schema

count
integer

The number of nodes in the Node Pool.

Request Samples

curl -H "Content-Type: application/json" \
      -H "Authorization: Bearer $TOKEN" \
      -X PUT -d '{
        "count": 6
      }' \
      https://api.linode.com/v4/lke/clusters/12345/pools/456

Response Samples

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

Responses

200: Node Pool was successfully modified.

count
integer

The number of nodes in the Node Pool.

Delete Node Pool

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

Delete a specific Node Pool from a Kubernetes cluster.

Deleting a Node Pool is a destructive action and cannot be undone.

Deleting a Node Pool will delete all Linodes within that Pool.

Authorizations

Personal Access Token
OAuth: ( lke:read_write)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

poolId
Required
integer

ID of the Pool to look up

Request Samples

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

Response Samples

{}

Responses

200: Delete successful

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.