Skip to content

Known Label

Low Risk

Operations on this resource are generally safe.

GET is generic label query. Two types of queries are supported Return label with exact matching entry label key = label value. Return list of labels that have prefix of label key = label value. Returns list of labels. Query will look into current tenants shared namespace and VES-I/O shared.

Tools

Tool Description
f5xc-api-users-known-label-list GET

Parameters

Path Parameters

Parameter Description Example
namespace Namespace -

Query Parameters

Parameter Description Example
key Key of the label to be retrieved. -
query Query type -
value Value of the label to be retrieved. -

Example Usage

Ask Claude to help you work with Known Label resources:

List Known Labels

"List all known-labels in the 'production' namespace"

CURL Examples

# List resources
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/known_labels" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Get specific resource
curl -X GET "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/known_labels/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json"

# Create resource
curl -X POST "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/known_labels" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}" \
  -H "Content-Type: application/json" \
  -d @known_label.json

# Delete resource
curl -X DELETE "https://${TENANT}.console.ves.volterra.io/api/config/namespaces/${NAMESPACE}/known_labels/<name>" \
  -H "Authorization: APIToken ${F5XC_API_TOKEN}"