Clusters

List clusters and download kubeconfig files for your Release account.

Base URL: https://api.release.com

---

List Clusters

Retrieve all clusters for a given account.

Endpoint

GET /accounts/{accountId}/clusters

Authentication

Authenticate using headers from your ~/.release.yaml file. To set this up, install the Release CLI and run release auth login.

Header	Description
X-User-Email	User email from ~/.release.yaml (login field)
X-User-Token	User token from ~/.release.yaml (token field)

Headers

Header	Value	Required
Accept	application/json	Yes

Path Parameters

Parameter	Type	Required	Description
accountId	string (hashid)	Yes	The unique identifier of the account

Status Codes

Status	Description
200	Successfully retrieved clusters
401	Unauthorized — invalid or missing authentication headers
404	Account not found

Example Responses

200 OK

[
  {
    "id": "gk7mxp",
    "name": "production-cluster",
    "provider": "aws",
    "region": "us-east-1"
  }
]

---

Get Cluster

Retrieve details for a specific cluster.

Endpoint

GET /accounts/{accountId}/clusters/{id}

Authentication

Authenticate using headers from your ~/.release.yaml file. To set this up, install the Release CLI and run release auth login.

Header	Description
X-User-Email	User email from ~/.release.yaml (login field)
X-User-Token	User token from ~/.release.yaml (token field)

Headers

Header	Value	Required
Accept	application/json	Yes

Path Parameters

Parameter	Type	Required	Description
accountId	string (hashid)	Yes	The unique identifier of the account
id	string (hashid)	Yes	The unique identifier of the cluster

Status Codes

Status	Description
200	Successfully retrieved cluster
401	Unauthorized — invalid or missing authentication headers
404	Account or cluster not found

Example Responses

200 OK

{
  "id": "gk7mxp",
  "name": "production-cluster",
  "provider": "aws",
  "region": "us-east-1"
}

---

Download Kubeconfig

Download the kubeconfig YAML file for a specific cluster.

Note: The response is the kubeconfig YAML file content, not JSON. The response Content-Type may be application/x-yaml or text/yaml.

Endpoint

GET /accounts/{accountId}/clusters/{id}/kubeconfig

Authentication

Authenticate using headers from your ~/.release.yaml file. To set this up, install the Release CLI and run release auth login.

Header	Description
X-User-Email	User email from ~/.release.yaml (login field)
X-User-Token	User token from ~/.release.yaml (token field)

Headers

Header	Value	Required
Accept	application/x-yaml	Yes

Path Parameters

Parameter	Type	Required	Description
accountId	string (hashid)	Yes	The unique identifier of the account
id	string (hashid)	Yes	The unique identifier of the cluster

Status Codes

Status	Description
200	Successfully retrieved kubeconfig
401	Unauthorized — invalid or missing authentication headers
404	Account or cluster not found

Example Responses

200 OK

apiVersion: v1
kind: Config
clusters:
  - cluster:
      server: https://kubernetes.example.com
      certificate-authority-data: LS0tLS1C...
    name: production-cluster
contexts:
  - context:
      cluster: production-cluster
      user: release-user
    name: production-context
current-context: production-context
users:
  - name: release-user
    user:
      token: eyJhbGci...