---
title: "GET /api/v1/clusters/{cluster_name}"
method: GET
path: "/api/v1/clusters/{cluster_name}"
tags: ["Cluster"]
---

# GET /api/v1/clusters/{cluster_name}

`GET /api/v1/clusters/{cluster_name}`

## Path parameters

- `cluster_name` string, required

## Response `200`

OK

- ApiClusterV1GetReply — GetReply represents a response to a get request.
  - `name` string — name is the name of the cluster.
  - `cluster_kind` string — cluster_kind is the kind of the cluster.
  - `cluster_type` string — cluster_type is the type of the cluster.
  - `usage` string — usage is the usage of the cluster.
  - `host_cluster` string — host_cluster specifies the host cluster name if the cluster is a virtual cluster.
  - `primary_domain` string — primary_domain is used to build the domain of components within the cluster.
  - `worker_type` string — worker_type maybe pipeline or deployment, when the cluster usage is 'worker', the WorkType is required.
  - `api_server` string — api_server specifies the API server address of the cluster.
  - `components_list` ApiClusterV1ComponentsList
    - `multi_tenant` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `secret_sync` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `gateway` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `deployment` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `progressive_delivery` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `pipeline` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
    - `event_listener` ApiClusterV1Component
      - `name` string
      - `namespace` string
      - `additions` object
  - `reserved_namespaces_allowed_products` object — // reserved_namespaces_allowed_products key is namespace name, value is the product name list witch can use namespace.
  - `product_allowed_cluster_resources` object — // product_allowed_cluster_resources key is product name, value is the list of cluster resources.

## Changes

- **2023-11-24** `58206cc16454` — 1 breaking, 7 warning, 1 info
  - the `components_list` response's property type/format changed from `object`/`` to ``/`` for status `200`
  - removed the optional property `components_list/deployment` from the response with the `200` status
  - removed the optional property `components_list/event_listener` from the response with the `200` status
  - removed the optional property `components_list/gateway` from the response with the `200` status
  - …5 more
- **2023-09-25** `55de8d9ba194` — 1 warning
  - removed the optional property `components_list/cert_management` from the response with the `200` status
- **2023-09-13** `2bd9e337f836` — 3 warning, 8 info
  - removed the optional property `components_list/cert_mgt` from the response with the `200` status
  - removed the optional property `components_list/ingress_controller` from the response with the `200` status
  - removed the optional property `components_list/secret_mgt` from the response with the `200` status
  - added the optional property `components_list/cert_management` to the response with the `200` status
  - …7 more
- …earlier changes not shown

[Full history](https://skmtc.dev/nautes-labs/apis/untitled-api/changes/api/v1/clusters/:cluster_name/get.md)

---

[API](https://skmtc.dev/nautes-labs/apis/untitled-api.md) · [All operations](https://skmtc.dev/nautes-labs/apis/untitled-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/nautes-labs/untitled-api/revisions/ce38dc32cd8a/schema)