​

ves-io-schema-cluster-API-List

Published April 5, 2023 | Last modified June 26, 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: ca420a29-5d51-4de1-a277-2e1f70a18a27
- annotations: {}
  labels: {}
  name: productpage-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: 74492c52-cd03-4d5e-a614-5e25f685a0e8
- annotations: {}
  labels: {}
  name: ratings-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: 09c7392c-9a13-43e1-9245-8452a44b5510
- annotations: {}
  labels: {}
  name: reviews-cluster
  namespace: documentation
  statusSet: []
  tenant: acmecorp
  uid: 13e7596e-1332-4dc5-9f56-44b7a1c480a7
Copied!

Request using curl:

curl -X 'GET' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build336959812_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: Thu, 26 Jun 2025 23:54:56 GMT
Vary: Accept-Encoding

{
  "items": [
    {
      "tenant": "acmecorp",
      "namespace": "documentation",
      "name": "details-cluster",
      "uid": "ca420a29-5d51-4de1-a277-2e1f70a18a27",
      "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": "74492c52-cd03-4d5e-a614-5e25f685a0e8",
      "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": "09c7392c-9a13-43e1-9245-8452a44b5510",
      "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": "13e7596e-1332-4dc5-9f56-44b7a1c480a7",
      "description": "",
      "disabled": false,
      "labels": {
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "get_spec": null,
      "status_set": [
      ]
    }
  ],
  "errors": [
  ]
}
Copied!
On this page: