View All Products
Compute
Storage
Databases
Networking
Developer Tools
Delivery
Security
Services
Industries
Pricing
Community
Engage With Us
Linode API 4.163.0

Endpoints

Linode Kubernetes Engine (LKE)

Node Pool View

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

Get a specific Node Pool by ID.

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",
  "tags": [],
  "disks": [
    {
      "size": 1024,
      "type": "ext-4"
    }
  ],
  "autoscaler": {
    "enabled": true,
    "max": 12,
    "min": 3
  },
  "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

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

tags
Filterable
array of objects

An array of tags applied to this object. Tags are for organizational purposes only.

disks
array of objects

This Node Pool's custom disk layout.

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.

autoscaler
object

When enabled, the number of nodes autoscales within the defined minimum and maximum values.

enabled
boolean

Whether autoscaling is enabled for this Node Pool. Defaults to false.

max
integer

The maximum number of nodes to autoscale to. Defaults to the Node Pool's count.

min
integer

The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.

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.

Node Pool Update

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

Updates a Node Pool's count and autoscaler configuration.

Linodes will be created or deleted to match changes to the Node Pool's count.

Any local storage on deleted Linodes (such as "hostPath" and "emptyDir" volumes, or "local" PersistentVolumes) will be erased.

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

autoscaler
object

When enabled, the number of nodes autoscales within the defined minimum and maximum values.

When making a request, max and min require each other.

enabled
boolean

Whether autoscaling is enabled for this Node Pool. Defaults to false.

max
integer

The maximum number of nodes to autoscale to. Defaults to the Node Pool's count. Defaults to the value provided by the count field.

min
integer

The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.

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,
        "autoscaler": {
          "enabled": true,
          "max": 12,
          "min": 3
      }' \
      https://api.linode.com/v4/lke/clusters/12345/pools/456

Response Samples

{
  "id": 1234,
  "type": "g6-standard-4",
  "tags": [],
  "autoscaler": {
    "enabled": true,
    "max": 12,
    "min": 3
  },
  "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.

autoscaler
object

When enabled, the number of nodes autoscales within the defined minimum and maximum values.

When making a request, max and min require each other.

enabled
boolean

Whether autoscaling is enabled for this Node Pool. Defaults to false.

max
integer

The maximum number of nodes to autoscale to. Defaults to the Node Pool's count. Defaults to the value provided by the count field.

min
integer

The minimum number of nodes to autoscale to. Defaults to the Node Pool's count.

Node Pool Delete

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.

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.