List API keys

GET 
/v2/api_keys

List API keys

Request

Query Parameters

limit int32

Possible values: >= 1 and <= 100

Default value: 10

Max number of API keys to return at one time.

page_key string

Used to retrieve the next page of API keys after the limit has been reached.

corpus_key CorpusKey

Possible values: <= 50 characters, Value must match regular expression [a-zA-Z0-9_\=\-]+$

Filters the API keys to only those with permissions on the specified corpus key.

Header Parameters

Request-Timeout integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified seconds or time out.

Request-Timeout-Millis integer

Possible values: >= 1

The API will make a best effort to complete the request in the specified milliseconds or time out.

Responses

200

An array of API keys.

application/json

Schema

Schema

api_keys object[]
List of API keys.
Array [
id string
Possible values: Value must match regular expression aky_.*
The ID of the API key.
name string
The human-readable name of the API key.
secret_key string
The key used in API requests. The key should be kept secure.
enabled boolean
If this API key is enabled.
api_key_role ApiKeyRole
Possible values: [serving, serving_and_indexing, personal]
Role of the API key. A serving API key can only perform query type requests on its corpora. A serving and indexing key can perform both indexing and query type requests on its corpora. A personal API key has all the same permissions as the creator of the API key.
api_policy object
What actions a principal can take on the Vectara platform.
name stringrequired
The name of the API role.
allowed_operations objectrequired
Operations that are allowed by the API role. Each operation may only allow certain resources that are described by a resource path to resource value map. If the value is null, then the operation is allowed on any resource.
property name* ApiOperationPolicy
Policy to allow operations if only using the specified resource.
allow_any_resource booleanrequired
Default value: true
If any resource is allowed for the operation.
allowed_resources object
Object with keys of resource paths to a list of allowed resources. A resource path starts with either body, path, or implicit. A body or path resource is within the operation body, and an implicit resource is a resource implied by the request.
property name* string[]
Array [
string
]
]
metadata object

The standard metadata in the response of a list operation.

page_key string

When requesting the next page of this list, this is needed as a query parameter.

Example (from schema)

{
  "api_keys": [
    {
      "id": "string",
      "name": "string",
      "secret_key": "string",
      "enabled": true,
      "api_key_role": "serving",
      "api_policy": {
        "name": "string",
        "allowed_operations": {}
      }
    }
  ],
  "metadata": {
    "page_key": "string"
  }
}

400

API key list request was malformed.

application/json

Schema

Schema

field_errors object
The errors that relate to specific fields in the request.
property name* string
messages message[]
request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "field_errors": {},
  "messages": [
    "string"
  ],
  "request_id": "string"
}

403

Permissions do not allow listing API keys.

application/json

Schema

Schema

messages message[]

The messages describing why the error occurred.

request_id string

The ID of the request that can be used to help Vectara support debug what went wrong.

Example (from schema)

{
  "messages": [
    "Internal server error."
  ],
  "request_id": "string"
}

Loading...