GRgravitee-io
Clusters

Search clusters

Changed on

User must have the ENVIRONMENT_CLUSTER[READ] permission.

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
    • HTTP basic
    • or API key in cookie Auth-Graviteeio-APIM

Query parameters

pageinteger

The page number for pagination.

perPageinteger

The number of items per page for pagination.

sortBy'name' | '-name' | 'createdAt' | '-createdAt' | 'updatedAt' | '-updatedAt'
Example:name

Possibility to sort Cluster results by field. Can be ascending or descending with minus '-' prefix. By default, it is sorted by name.

qstring
Example:my cluster

A search query to filter clusters.

type'KAFKA_CLUSTER_STANDALONE' | 'KAFKA_CLUSTER' | 'KAFKA_VIRTUAL_CLUSTER'

Filter clusters by type.

lifecycleStatestring[]

Filter clusters by lifecycle state. Repeat the parameter to match several states.

Response

Page of clusters

Changes

  • fc21ae658d19Revision changes
    • info

      added the new optional query request parameter lifecycleState

  • ac9b3975b952Revision changes
    • warning

      added the new KAFKA_VIRTUAL_CLUSTER enum value to the // response property for the response status

    • info

      added the new enum value KAFKA_VIRTUAL_CLUSTER to the query request parameter type