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

# GET /api/v1/clusters

`GET /api/v1/clusters`

## Request

- The document declares no server URL.
- Auth: none declared

## Query parameters

- `field_selector` string

## Response `200`

OK

- ApiClusterV1ListsReply: ListsReply represents a response to a list request.
  - `items` ApiClusterV1GetReply[]
    - `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-12-21** `58206cc16454`: 1 breaking, 7 warning, 1 info
  - the `items/items/components_list` response's property type changed from `object` to no type for status `200`
  - removed the optional property `items/items/components_list/deployment` from the response with the `200` status
  - removed the optional property `items/items/components_list/event_listener` from the response with the `200` status
  - removed the optional property `items/items/components_list/gateway` from the response with the `200` status
  - …5 more
- **2023-09-27** `55de8d9ba194`: 1 warning
  - removed the optional property `items/items/components_list/cert_management` from the response with the `200` status
- **2023-09-27** `2bd9e337f836`: 3 warning, 8 info
  - removed the optional property `items/items/components_list/cert_mgt` from the response with the `200` status
  - removed the optional property `items/items/components_list/ingress_controller` from the response with the `200` status
  - removed the optional property `items/items/components_list/secret_mgt` from the response with the `200` status
  - added the optional property `items/items/components_list/cert_management` to the response with the `200` status
  - …7 more
- …earlier changes not shown

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

---

[API](https://skmtc.dev/nautes-labs/apis/nautes-api.md) - [All operations](https://skmtc.dev/nautes-labs/apis/nautes-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nautes-labs/apis/nautes-api/revisions/ce38dc32cd8a?raw)