---
title: "Get returns a cluster resource by name."
method: GET
path: "/rest-api/v1/cluster/{clusterName}"
tags: ["cluster"]
---

# Get returns a cluster resource by name.

`GET /rest-api/v1/cluster/{clusterName}`

This endpoint returns a cluster resource by name.

## Path parameters

- `clusterName` string, required

## Query parameters

- `format` string

## Response `200`

Unstructured object

- UnstructuredUnstructured
  - `object` object — Object is a JSON compatible map with string, float, int, bool, []interface{}, or map[string]interface{} children.

## Other responses

- `400` — Bad Request
- `401` — Unauthorized
- `404` — Not Found
- `405` — Method Not Allowed
- `429` — Too Many Requests
- `500` — Internal Server Error

## Changes

- **2024-03-27** `77cc19a13715` — 1 breaking
  - added the new path request parameter `clusterName`
- **2023-12-29** `fa4b9c305a29` — 1 info
  - endpoint added
- **2023-12-11** `2a20fa0acab4` — 1 breaking
  - api path removed without deprecation

[Change history](https://skmtc.dev/kusionstack/apis/karpor/changes/rest-api/v1/cluster/:clusterName/get.md)

---

[API](https://skmtc.dev/kusionstack/apis/karpor.md) · [All operations](https://skmtc.dev/kusionstack/apis/karpor/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/kusionstack/karpor/revisions/d741ac56c269/schema)