---
title: "List returns list of clusters"
method: GET
path: "/api/v1/clusters"
tags: ["ClusterService"]
---

# List returns list of clusters

`GET /api/v1/clusters`

## Query parameters

- `server` string

## Response `200`

(empty)

- V1alpha1ClusterList — ClusterList is a collection of Clusters.
  - `items` V1alpha1Cluster[]
    - `config` V1alpha1ClusterConfig — ClusterConfig is the configuration attributes. This structure is subset of the go-client rest.Config with annotations added for marshalling.
      - `awsAuthConfig` V1alpha1AWSAuthConfig
        - `clusterName` string
        - `roleARN` string — RoleARN contains optional role ARN. If set then AWS IAM Authenticator assume a role to perform cluster operations instead of the default AWS credential provider chain.
      - `bearerToken` string — Server requires Bearer authentication. This client will not attempt to use refresh tokens for an OAuth2 flow. TODO: demonstrate an OAuth2 compatible client.
      - `password` string
      - `tlsClientConfig` V1alpha1TLSClientConfig
        - `caData` string, byte
        - `certData` string, byte
        - `insecure` boolean — Server should be accessed without verifying the TLS certificate. For testing only.
        - `keyData` string, byte
        - `serverName` string — ServerName is passed to the server for SNI and is used in the client to check server certificates against. If ServerName is empty, the hostname used to contact the server is used.
      - `username` string
    - `connectionState` V1alpha1ConnectionState
      - `attemptedAt` V1Time — Time is a wrapper around time.Time which supports correct marshaling to YAML and JSON. Wrappers are provided for many of the factory methods that the time package offers. +protobuf.options.marshal=false +protobuf.as=Timestamp +protobuf.options.(gogoproto.goproto_stringer)=false
        - `nanos` integer — Non-negative fractions of a second at nanosecond resolution. Negative second values with fractions must still have non-negative nanos values that count forward in time. Must be from 0 to 999,999,999 inclusive. This field may be limited in precision depending on context.
        - `seconds` string, int64 — Represents seconds of UTC time since Unix epoch 1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to 9999-12-31T23:59:59Z inclusive.
      - `message` string
      - `status` string
    - `name` string
    - `server` string
  - `metadata` V1ListMeta — ListMeta describes metadata that synthetic resources must have, including lists and various status objects. A resource may have only one of {ObjectMeta, ListMeta}.
    - `continue` string — continue may be set if the user set a limit on the number of items returned, and indicates that the server has more data available. The value is opaque and may be used to issue another request to the endpoint that served this list to retrieve the next set of available objects. Continuing a consistent list may not be possible if the server configuration has changed or more than a few minutes have passed. The resourceVersion field returned when using this continue value will be identical to the value in the first response, unless you have received this token from an error message.
    - `resourceVersion` string
    - `selfLink` string

---

[API](https://skmtc.net/devtron-labs/apis/consolidate-services.md) · [All operations](https://skmtc.net/devtron-labs/apis/consolidate-services/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/devtron-labs/consolidate-services/versions/778bfc291d1e/schema)