List API Keys API Definition

The List API Keys API lists all existing API keys for a customer ID. It also shows what corpora are accessed by these keys and with what permissions. This capability can provide insights into key usage and status and help you manage the lifecycle and security of your API keys.

List API Keys Request and Response

To list API keys, send a GET request to /v2/api_keys.

The response includes an api_keys array field that contains information about the API keys, and a metadata field containing information such as pagination key.

REST 2.0 URL

List API Keys Endpoint Address

Vectara exposes a REST endpoint at the following URL to list API keys:

https://api.vectara.io/v2/api-keys

The API Reference shows the full List API Keys REST definition.

gRPC Example

You can find the full List API Keys gRPC definition at admin_apikey.proto.