---
title: "Search clusters"
method: GET
path: "/clusters"
tags: ["Clusters"]
---

# Search clusters

`GET /clusters`

User must have the ENVIRONMENT_CLUSTER[READ] permission.

## Query parameters

- `page` integer
- `perPage` integer
- `sortBy` 'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'
- `q` string
- `type` 'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'
- `lifecycleState` string[]

## Response `200`

Page of clusters

- object
  - `data` Cluster[] — List of Clusters.
    - `id` string
    - `crossId` string — Portable identifier for cross-environment references. Immutable after creation.
    - `type` 'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'
    - `createdAt` string, date-time
    - `updatedAt` string, date-time
    - `name` string
    - `description` string
    - `configuration` object
    - `groups` string[]
    - `lifecycleState` 'UNDEPLOYED' | 'DEPLOYED' | 'PENDING' — Current lifecycle state of the cluster.
    - `deployedAt` string, date-time — Last deployment or undeployment timestamp.
    - `version` integer — Deployment version, incremented on each deploy.
  - `pagination` Pagination — Generic object to handle pagination data.
    - `page` integer — The current page.
    - `perPage` integer — The number of items requested per page.
    - `pageCount` integer — The total number of pages.
    - `pageItemsCount` integer — The number of items for the current page.
    - `totalCount` integer — The total number of items, or `-1` if the count could not be computed within the configured timeout.
  - `links` Links — List of links for pagination
    - `self` string — Link to current resource
    - `first` string — In a paginated response, link to the first page
    - `last` string — In a paginated response, link to the last page
    - `previous` string — In a paginated response, link to the previous page. Maybe null if current is the first page
    - `next` string — In a paginated response, link to the next page. Maybe null if current is the last page

## Other responses

- `default` — Generic error response

---

[API](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-environments.md) · [All operations](https://skmtc.net/gravitee-io/apis/gravitee-io-apim-management-api-environments/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gravitee-io/gravitee-io-apim-management-api-environments/versions/37e8cbe5f769/schema)