> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://americancloud.com/docs/api/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://americancloud.com/docs/api/_mcp/server.

# Get details of a specific Kubernetes cluster

GET https://api.americancloud.com/api/v1/kubernetes/clusters/{id}

Returns cluster details. Set details=true to include node instances and attached storage volumes.

Reference: https://americancloud.com/docs/api/api-reference/kubernetes/get-cluster-kubernetes

## Authentication

- `X-API-Client-ID` header (required) — API Client ID
- `X-API-Client-Secret` header (required) — API Client Secret

## Request

### Path parameters

- `id` (string, required) — ID of the Kubernetes cluster

### Query parameters

- `details` (boolean, optional) — Include node instances and storage volumes in the response

## Response

### 200

Kubernetes cluster details

- `id` (string, required) — Unique identifier for the cluster.
- `name` (string, required) — Human-readable name for the cluster.
- `region` (string, required) — Region the cluster is deployed in.
- `status` (string, required) — Current lifecycle state of the cluster.
- `kubernetesVersion` (string, required) — Kubernetes version the cluster is running.
- `createdAt` (datetime, required) — When the cluster was created.
- `package` (string, required) — Package label describing the per-node CPU/memory/disk preset.
- `description` (string, required) — Description of the cluster.
- `nodePool` (KubernetesNodePool, required) — Node-pool configuration for the cluster.
- `ipAddress` (string, optional) — Public IP address attached to the cluster.
- `ipAddressId` (string, optional) — Identifier of the public IP attached to the cluster.
- `deletedAt` (datetime, optional) — When the cluster was deleted. Omitted if the cluster still exists.
- `nodes` (list of KubernetesNodeResponse, optional) — Cluster nodes. Only included when `details=true`.

## Errors

### 400 Bad Request Error

The request was malformed or failed validation.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 401 Unauthorized Error

Authentication credentials were missing or invalid.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 403 Forbidden Error

The authenticated principal is not permitted to perform this action.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 404 Not Found Error

The requested resource does not exist or is not accessible to the caller.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

### 500 Internal Server Error

An unexpected error occurred on the server.

- `statusCode` (double, required) — HTTP status code.
- `message` (ApiErrorDtoMessage, required) — Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.
- `error` (string, optional) — Short HTTP error label.
- `code` (string, optional) — Machine-readable reason for the error. Match on this value rather than on `message`, which can be reworded at any time. Present on the errors that have more than one cause for the same status code; omitted otherwise.
- `errors` (list of ValidationErrorItemDto, optional) — Per-field validation details. Present on 400 responses produced by request-body validation; omitted otherwise.
- `snapshots` (list of BlockingSnapshotDto, optional) — The snapshots that block a delete. Present on a 409 whose `code` is `volume_has_snapshots`; omitted otherwise.

## Types

### KubernetesNodePool

- `controlNodes` (double, required) — Number of control-plane nodes in the cluster.
- `workerNodes` (double, required) — Number of worker nodes in the cluster.
- `autoscalingEnabled` (boolean, required) — Whether the cluster scales worker nodes automatically based on load.
- `cpuCores` (double, required) — Number of virtual CPU cores allocated to each node.
- `memoryMb` (integer, required) — Memory allocated to each node, in megabytes.
- `minWorkers` (double, optional) — Floor for worker-node count when autoscaling is enabled.
- `maxWorkers` (double, optional) — Ceiling for worker-node count when autoscaling is enabled.

### KubernetesNodeResponse

- `id` (string, required) — Unique identifier for the node.
- `name` (string, required) — Hostname of the node.
- `role` (enum, required) — Role this node plays in the cluster.
  - Allowed values: `control`, `worker`, `unknown`
- `state` (string, required) — Current lifecycle state of the node.
- `cpuCores` (double, required) — Number of virtual CPU cores allocated to the node.
- `memoryMb` (integer, required) — Memory allocated to the node, in megabytes.
- `rootVolume` (KubernetesNodeRootVolume, required) — Root disk attached to the node.
- `createdAt` (datetime, required) — When the node was provisioned.
- `ipAddress` (string, optional) — Private IP address assigned to the node.

### ApiErrorDtoMessage

Human-readable error message. A single string for most errors, or an array of strings when the request failed multiple validation checks.

### ValidationErrorItemDto

- `field` (string, required) — Dotted path to the field that failed validation.
- `message` (string, required) — Human-readable validation message for this field.

### BlockingSnapshotDto

- `id` (string, required) — Snapshot ID.
- `name` (string, required) — Snapshot name.

### KubernetesNodeRootVolume

- `name` (string, required) — Name of the root volume.
- `sizeGb` (integer, required) — Root volume size, in gigabytes.

## Examples

**Response**

```json
{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "name": "production-cluster",
  "region": "sjc0",
  "status": "running",
  "kubernetesVersion": "1.29.4",
  "createdAt": "2026-05-29T12:34:56Z",
  "package": "standard-2-4",
  "description": "Primary production Kubernetes cluster.",
  "nodePool": {
    "controlNodes": 1,
    "workerNodes": 3,
    "autoscalingEnabled": false,
    "cpuCores": 2,
    "memoryMb": 4096,
    "minWorkers": 2,
    "maxWorkers": 10
  },
  "ipAddress": "203.0.113.5",
  "ipAddressId": "123e4567-e89b-12d3-a456-426614174000",
  "deletedAt": "2026-05-29T12:34:56Z",
  "nodes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "name": "k8s-worker-01",
      "role": "worker",
      "state": "running",
      "cpuCores": 2,
      "memoryMb": 4096,
      "rootVolume": {
        "name": "k8s-node-root",
        "sizeGb": 50
      },
      "createdAt": "2026-05-29T12:34:56Z",
      "ipAddress": "192.168.1.10"
    }
  ]
}
```

**SDK Code**

```python
import requests

url = "https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000"

headers = {"X-API-Client-ID": "<apiKey>"}

response = requests.get(url, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000';
const options = {method: 'GET', headers: {'X-API-Client-ID': '<apiKey>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("X-API-Client-ID", "<apiKey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["X-API-Client-ID"] = '<apiKey>'

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000")
  .header("X-API-Client-ID", "<apiKey>")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000', [
  'headers' => [
    'X-API-Client-ID' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000");
var request = new RestRequest(Method.GET);
request.AddHeader("X-API-Client-ID", "<apiKey>");
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = ["X-API-Client-ID": "<apiKey>"]

let request = NSMutableURLRequest(url: NSURL(string: "https://api.americancloud.com/api/v1/kubernetes/clusters/123e4567-e89b-12d3-a456-426614174000")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```