Linode Kubernetes Engine (LKE)

Node View

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

Returns the values for a specified node object.

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster containing the Node.

nodeId
Required
string

ID of the Node to look up.

Request Samples

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

Response Samples

{
  "status": "ready",
  "id": 1234,
  "instance_id": 123456
}

Responses

200: Returns the values of a node object in the form that it appears currently in the node pool array.

status
string
Enum: "ready""not_ready"

The creation status of this Node. This status is distinct from this Node's readiness as a Kubernetes Node Object as determined by the command kubectl get nodes.

not_ready indicates that the Linode is still being created.

ready indicates that the Linode has successfully been created and is running Kubernetes software.

id
string

The Node's ID.

instance_id
integer

The Linode's ID. If no Linode is currently provisioned for this Node, this is null.

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.

Node Delete

delete
https://api.linode.com/v4/lke/clusters/{clusterId}/nodes/{nodeId}

Deletes a specific Node from a Node Pool.

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

Deleting a Node will reduce the size of the Node Pool it belongs to.

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster containing the Node.

nodeId
Required
string

ID of the Node to look up.

Request Samples

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

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.