Give Feedback

doctl kubernetes cluster get

Generated on 9 Apr 2025 from doctl version v1.124.0

Usage

doctl kubernetes cluster get <id|name> [flags]

Retrieves the following details about a Kubernetes cluster:

A unique ID for the cluster
A human-readable name for the cluster
The slug identifying the region where the Kubernetes cluster is located
The slug identifying the cluster’s Kubernetes version. If set to a minor version, the latest patch version for that minor version is returned. For example, if the cluster is set to 1.14, the command would return 1.14.6-do.1. If it is set to latest, the latest published version is used.
A boolean value indicating whether the cluster automatically upgrades to new patch releases during its maintenance window.
An object containing a “state” attribute whose value is set to a string indicating the current status of the node. Potential values: running, provisioning, errored.
The base URL of the cluster’s Kubernetes API server
The public IPv4 address of the cluster’s Kubernetes API server
The range of IP addresses in the overlay network of the Kubernetes cluster, in CIDR notation
The range of assignable IP addresses for services running in the Kubernetes cluster, in CIDR notation
An array of tags applied to the Kubernetes cluster. All clusters are automatically tagged k8s and k8s:$K8S_CLUSTER_ID.
When the Kubernetes cluster was created, in ISO8601 combined date and time format
When the Kubernetes cluster was last updated, in ISO8601 combined date and time format
A list of node pools available inside the cluster

The following example retrieve details about a Kubernetes cluster named example-cluster:

doctl kubernetes cluster get example-cluster

Option	Description
`--format`	Columns for output in a comma-separated list. Possible values: `ID`, `Name`, `Region`, `Version`, `AutoUpgrade`, `HAControlPlane`, `Status`, `Endpoint`, `IPv4`, `ClusterSubnet`, `ServiceSubnet`, `Tags`, `Created`, `Updated`, `NodePools`, `Autoscaler.UtilizationThreshold`, `Autoscaler.UnneededTime`, `RoutingAgent`.
`--help`, `-h`	Help for this command
`--no-header`	Return raw data with no headers Default: `false`

Command	Description
doctl kubernetes cluster	Display commands for managing Kubernetes clusters

Option	Description
`--access-token`, `-t`	API V2 access token
`--api-url`, `-u`	Override default API endpoint
`--config`, `-c`	Specify a custom config file Default:
`--context`	Specify a custom authentication context name
`--http-retry-max`	Set maximum number of retries for requests that fail with a 429 or 500-level error Default: `5`
`--http-retry-wait-max`	Set the minimum number of seconds to wait before retrying a failed request Default: `30`
`--http-retry-wait-min`	Set the maximum number of seconds to wait before retrying a failed request Default: `1`
`--interactive`	Enable interactive behavior. Defaults to true if the terminal supports it (default false) Default: `false`
`--output`, `-o`	Desired output format [text\|json] Default: `text`
`--trace`	Show a log of network activity while performing a command Default: `false`
`--verbose`, `-v`	Enable verbose output Default: `false`