​

ves-io-schema-registration-CustomAPI-ListRegistrationsByState

Published April 5, 2023 | Last modified November 14, 2025

Examples of performing registration CustomAPI ListRegistrationsByState

Usecase:

List registrations by state

Request:

Request using vesctl:

vesctl request rpc registration.CustomAPI.ListRegistrationsByState -i request.yaml --uri /public/namespaces/system/listregistrationsbystate --http-method POST

where file request.yaml has following contents:

namespace: system
state: APPROVED
Copied!

vesctl yaml response:

errors: []
items:
- annotations: {}
  labels:
    abc: def
  name: reg-347d9574-4f8b-4163-a333-5c922e25cc68
  namespace: system
  tenant: customer1
  uid: 347d9574-4f8b-4163-a333-5c922e25cc68
Copied!

Request using curl:

curl -X 'POST' -d '{"namespace":"system","state":"APPROVED"}' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build4194363419_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/register/namespaces/system/listregistrationsbystate'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 476
Content-Type: application/json
Date: Thu, 13 Nov 2025 23:06:54 GMT
Vary: Accept-Encoding

{
  "items": [
    {
      "tenant": "customer1",
      "namespace": "system",
      "name": "reg-347d9574-4f8b-4163-a333-5c922e25cc68",
      "uid": "347d9574-4f8b-4163-a333-5c922e25cc68",
      "description": "",
      "disabled": false,
      "labels": {
        "abc": "def"
      },
      "annotations": {
      },
      "owner_view": null,
      "metadata": null,
      "system_metadata": null,
      "object": null,
      "get_spec": null
    }
  ],
  "errors": [
  ]
}
Copied!
On this page: