​

ves-io-schema-operate-debug-CustomPublicAPI-HealthPublic

Published April 5, 2023 | Last modified October 28, 2026

Examples of performing debug CustomPublicAPI HealthPublic

Usecase:

Retrieve VPM health information

Request:

Request using vesctl:

vesctl request rpc debug.CustomPublicAPI.HealthPublic -i request.yaml --uri /public/namespaces/system/sites/site1/vpm/debug/global/health --http-method GET

where file request.yaml has following contents:

site: site1

vesctl yaml response:

roles: []

Request using curl:

curl -X 'GET' -H 'Content-Type: application/json' -H 'X-Volterra-Useragent: v1/pgm=_var_folders_q2_3kp8z3zs0x5_m7pk1bgb0_ph0000gp_T_go-build3348201650_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/operate/namespaces/system/sites/site1/vpm/debug/global/health?console_user=&site=site1'

curl response:

HTTP/1.1 200 OK
Content-Length: 336
Content-Type: application/json
Date: Mon, 28 Sep 2026 04:26:26 GMT
Vary: Accept-Encoding


{
  "state": "WAITING_FOR_CONFIG",
  "hostname": "",
  "os_info": null,
  "version": "",
  "initial_password_changed": false,
  "wifi_support": false,
  "os_version": "",
  "software_version": "",
  "public_ip": "",
  "lte_support": false,
  "roles": [
  ],
  "fqdn": "",
  "vesop_ssh_enabled": false,
  "vesop_ssh_remaining_time": ""
}
On this page: