​

ves-io-schema-known_label-CustomAPI-Get

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

Examples of performing known_label CustomAPI Get

Usecase:

Get known_label

Request:

Request using vesctl:

vesctl request rpc known_label.CustomAPI.Get -i request.yaml --uri /public/namespaces/shared/known_labels --http-method GET

where file request.yaml has following contents:

key: acmecorp/storetype
namespace: shared
query: QUERY_EXACT_LABEL
value: superstore
Copied!

vesctl yaml response:

label:
- description: acmecorp site type is superstore
  key: acmecorp/storetype
  value: superstore
Copied!

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-build2850427035_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/shared/known_labels?key=acmecorp%2Fstoretype&namespace=shared&query=QUERY_EXACT_LABEL&value=superstore'
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 152
Content-Type: application/json
Date: Fri, 19 Sep 2025 02:00:22 GMT
Vary: Accept-Encoding

{
  "label": [
    {
      "key": "acmecorp/storetype",
      "value": "superstore",
      "description": "acmecorp site type is superstore"
    }
  ]
}
Copied!

Usecase:

Get known_label

Request:

Request using vesctl:

vesctl request rpc known_label.CustomAPI.Get -i request.yaml --uri /public/namespaces/shared/known_labels --http-method GET

where file request.yaml has following contents:

namespace: shared
Copied!

vesctl yaml response:

label:
- description: acmecorp site type is superstore
  key: acmecorp/storetype
  value: superstore
- description: acmecorp site type is neighborhood store
  key: acmecorp/storetype
  value: neighborhood
- description: acmecorp site type is warehouse
  key: acmecorp/storetype
  value: warehouse
- description: acmecorp application deployment type is test setup
  key: acmecorp/deployment
  value: test
- description: acmecorp application deployment type is production
  key: acmecorp/deployment
  value: production
Copied!

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-build2850427035_b001_apidocs.test/host=MTY6VVHQPH/svc=S:examplesvc/site=mytestce01' 'https://acmecorp.console.ves.volterra.io/api/config/namespaces/shared/known_labels?key=&namespace=shared&query=QUERY_ALL_LABELS&value='
Copied!

curl response:

HTTP/1.1 200 OK
Content-Length: 724
Content-Type: application/json
Date: Fri, 19 Sep 2025 02:00:22 GMT
Vary: Accept-Encoding

{
  "label": [
    {
      "key": "acmecorp/storetype",
      "value": "superstore",
      "description": "acmecorp site type is superstore"
    },
    {
      "key": "acmecorp/storetype",
      "value": "neighborhood",
      "description": "acmecorp site type is neighborhood store"
    },
    {
      "key": "acmecorp/storetype",
      "value": "warehouse",
      "description": "acmecorp site type is warehouse"
    },
    {
      "key": "acmecorp/deployment",
      "value": "test",
      "description": "acmecorp application deployment type is test setup"
    },
    {
      "key": "acmecorp/deployment",
      "value": "production",
      "description": "acmecorp application deployment type is production"
    }
  ]
}
Copied!
On this page: