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

# Search clusters

`GET /clusters`

## Request

- Base URL: `/management/v2/environments/DEFAULT` (relative, and the document was published on a file host, not at the API’s origin)
- URL: `/management/v2/environments/DEFAULT/clusters`
- Auth: one of:
  - HTTP basic
  - API key in cookie `Auth-Graviteeio-APIM`

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

## Changes

- **2026-07-30** `fc21ae658d19`: 1 info
  - added the new optional `query` request parameter `lifecycleState`
- **2026-04-22** `ac9b3975b952`: 1 warning, 1 info
  - added the new `KAFKA_VIRTUAL_CLUSTER` enum value to the `data/items/type` response property for the response status `200`
  - added the new enum value `KAFKA_VIRTUAL_CLUSTER` to the `query` request parameter `type`
- **2026-04-22** `86ed32989ff4`: 1 breaking, 1 warning, 2 info
  - removed the enum value `KAFKA_CLUSTER_CONNECTION` from the `query` request parameter `type`
  - added the new `KAFKA_CLUSTER_STANDALONE` enum value to the `data/items/type` response property for the response status `200`
  - added the new enum value `KAFKA_CLUSTER_STANDALONE` to the `query` request parameter `type`
  - removed the `KAFKA_CLUSTER_CONNECTION` enum value from the `data/items/type` response property for the response status `200`
- **2026-04-20** `00b565da0a78`: 3 info
  - added the optional property `data/items/deployedAt` to the response with the `200` status
  - added the optional property `data/items/lifecycleState` to the response with the `200` status
  - added the optional property `data/items/version` to the response with the `200` status
- **2026-04-15** `576375ea01b9`: 1 info
  - added the optional property `data/items/crossId` to the response with the `200` status

[Operation history](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/changes/clusters/get.md)

---

[API](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments.md) - [All operations](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/llms.txt) - [OpenAPI document](https://skmtc.dev/gravitee-io/apis/gravitee-io-apim-management-api-environments/revisions/b736a7e375df?raw)