GET

GET

/api/config/namespaces/{namespace}/known_label_keys

curl --request GET \
  --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/known_label_keys?query=QUERY_ALL_LABEL_KEYS' \
  --header 'Authorization: <Authorization>'

• F5 Distributed Cloud Console

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

Examples of this operation.

Authorizations

• ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace Namespace in which to retrieve the label key.

Query Parameters

query

string

default: QUERY_ALL_LABEL_KEYS

Allowed values: QUERY_ALL_LABEL_KEYS QUERY_EXACT_LABEL_KEY QUERY_PREFIX_LABEL_KEYS

Query Type

Generic GET of all available labels for a given tenant GET exact match of label.key = label.value Or label.key(label.value) GET prefix match of label.key.

key

string

Key to retrieve.

Responses

200

A successful response.

Media typeapplication/json

Get Response

Response for GET API.

object

label_key

Label Key

Label Key

Array<object>

Label Key Type

Generic Label key type label.key.

object

description

Description

Description of what this label key means.

string

>= 21 characters <= 1024 characters

key

Key

Label key

string

>= 7 characters <= 1024 characters

Example^generated

{
  "label_key": [
    {
      "description": "example",
      "key": "example"
    }
  ]
}

401

Returned when operation is not authorized.

Media typeapplication/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

Media typeapplication/json

string format: string

Example^generated

example

404

Returned when resource is not found.

Media typeapplication/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

Media typeapplication/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

Media typeapplication/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

Media typeapplication/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

Media typeapplication/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

Media typeapplication/json

string format: string

Example^generated

example