clusters

List test clusters.

Required RBAC Policy: kots/cluster/list

get/clusters

Request

  • Base URL
    https://api.replicated.com/vendor/v3
  • URL
    https://api.replicated.com/vendor/v3/clusters
  • Auth
    API key in header Authorization

Query parameters

pageSizeinteger

Page size

currentPageinteger

Current page

sortColumnstring

Sort column

sortDescboolean

Sort descending

show-terminatedboolean
start-timestring

Specify a start time in the format "YYYY-MM-DDTHH:MM:SSZ".

end-timestring

Specify an end time in the format "YYYY-MM-DDTHH:MM:SSZ".

actor-filterstring

Filter clusters by actor type or name, e.g. "user" or "Replicated CLI".

tag-filterstring

Filter clusters by tag, e.g. "tag1=value1".

tag-sort-keystring

Sort clusters by a specific key, e.g. "terminated_at" would sort by termination time.

Response

ListClustersResponse contains the response to list clusters

errorstring
totalClustersinteger

Changes

No recorded changes to this operation across all 3 revisions of this API.