Linode Kubernetes Engine (LKE)

View Kubernetes Cluster

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

Get a specific Cluster by ID.

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

Response Samples

{
  "id": 1234,
  "created": "2019-09-12T21:25:30Z",
  "label": "lkecluster12345",
  "tags": [],
  "updated": "2019-09-13T21:24:16Z",
  "region": "us-central",
  "k8s_version": "1.16"
}

Responses

200: Returns a single Kubernetes cluster.

id
integer

This Kubernetes cluster's unique ID.

created
string <date-time>

When this Kubernetes cluster was created.

label
string [1 .. 32] characters

This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:

  • UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character is 3 bytes in UTF-8 (0xE382AB). Its Unicode code point is 2 bytes (0x30AB). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point ("\u30ab").
  • 4 byte UTF-8 characters are not supported.
  • If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.
tags
Filterable
array of objects

An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only.

updated
string <date-time>

When this Kubernetes cluster was updated.

region
string

This Kubernetes cluster's location.

k8s_version
string

The desired Kubernetes version for this Kubernetes cluster in the format of <major>.<minor>, and the latest supported patch version will be deployed.

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.

Update Kubernetes Cluster

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

Updates a 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

label
string [1 .. 32] characters

This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:

  • UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character is 3 bytes in UTF-8 (0xE382AB). Its Unicode code point is 2 bytes (0x30AB). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point ("\u30ab").
  • 4 byte UTF-8 characters are not supported.
  • If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.
tags
array

An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your tags array.

Request Samples

curl -H "Content-Type: application/json" \
      -H "Authorization: Bearer $TOKEN" \
      -X PUT -d '{
        "label": "lkecluster54321"
        "tags" : ["ecomm", "blog", "prod", "monitoring"]
      }' \
      https://api.linode.com/v4/lke/clusters/12345

Response Samples

{
  "label": "lkecluster12345",
  "tags": [],
  "created": "2019-09-12T21:25:30Z",
  "updated": "2019-09-13T21:24:16Z",
  "region": "us-central",
  "k8s_version": "1.16"
}

Responses

200: Returns a single Kubernetes cluster.

label
string [1 .. 32] characters

This Kubernetes cluster's unique label for display purposes only. Labels have the following constraints:

  • UTF-8 characters will be returned by the API using escape sequences of their Unicode code points. For example, the Japanese character is 3 bytes in UTF-8 (0xE382AB). Its Unicode code point is 2 bytes (0x30AB). APIv4 supports this character and the API will return it as the escape sequence using six 1 byte characters which represent 2 bytes of Unicode code point ("\u30ab").
  • 4 byte UTF-8 characters are not supported.
  • If the label is entirely composed of UTF-8 characters, the API response will return the code points using up to 193 1 byte characters.
tags
array of objects

An array of tags applied to the Kubernetes cluster. Tags are for organizational purposes only. To delete a tag, exclude it from your tags array.

Delete Kubernetes Cluster

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

Deletes a Cluster you have permission to read_write.

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

Deleting a Cluster:

  • Deletes all Linodes in all pools within this Kubernetes cluster
  • Deletes all supporting Kubernetes services for this Kubernetes cluster (API server, etcd, etc)
  • Deletes all NodeBalancers created by this Kubernetes cluster
  • Does not delete any of the volumes created by this Kubernetes cluster

Authorizations

Personal Access Token
OAuth: ( lke:read_write)

Path Parameters

clusterId
Required
integer

ID of the Kubernetes cluster to look up.

Request Samples

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

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.