​

ves-io-schema-cluster-API-List

Published April 5, 2023 | Last modified September 19, 2025

Examples of listing cluster

Usecase:

List all clusters in current namespace

Request using vesctl:

vesctl configuration list cluster --namespace documentation

vesctl yaml response:

errors: []
items:
- annotations: {}
  labels: {}
  name: details-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: eb7363fa-4563-47ef-943e-82cc4127fcb0
- annotations: {}
  labels: {}
  name: productpage-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: b936e85b-7411-4088-94ba-dc0fd1dbca2e
- annotations: {}
  labels: {}
  name: ratings-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: 79db4de8-0cae-4d25-88ba-20022c6559e5
- annotations: {}
  labels: {}
  name: reviews-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: afacb93f-fc55-44fd-ba24-816fe708dba3
Copied!

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build2850427035_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/documentation/clusters'
Copied!

curl response

HTTP/1.1 200 OK
Content-Type: application/json
Date: Fri, 19 Sep 2025 01:59:52 GMT
Vary: Accept-Encoding

{
  "items": [
    {
      "tenant": "acmecorp",
      "namespace": "documentation",
      "name": "details-cluster",
      "uid": "eb7363fa-4563-47ef-943e-82cc4127fcb0",
      "description": "",
      "disabled": false,
      "labels": {
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "get_spec": null,
      "status_set": [
      ]
    },
    {
      "tenant": "acmecorp",
      "namespace": "documentation",
      "name": "productpage-cluster",
      "uid": "b936e85b-7411-4088-94ba-dc0fd1dbca2e",
      "description": "",
      "disabled": false,
      "labels": {
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "get_spec": null,
      "status_set": [
      ]
    },
    {
      "tenant": "acmecorp",
      "namespace": "documentation",
      "name": "ratings-cluster",
      "uid": "79db4de8-0cae-4d25-88ba-20022c6559e5",
      "description": "",
      "disabled": false,
      "labels": {
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "get_spec": null,
      "status_set": [
      ]
    },
    {
      "tenant": "acmecorp",
      "namespace": "documentation",
      "name": "reviews-cluster",
      "uid": "afacb93f-fc55-44fd-ba24-816fe708dba3",
      "description": "",
      "disabled": false,
      "labels": {
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "get_spec": null,
      "status_set": [
      ]
    }
  ],
  "errors": [
  ]
}
Copied!
On this page: