Update API Key API Definition

The Update API Key API lets you enable or disable specific API keys. You can use this endpoint to temporarily disable access without deleting the key.

This capability is useful for scenarios like maintenance windows, or when your team no longer requires access to a specific corpus.

Update API Key Request and Response

To update an API key, send a PATCH request to /v2/api_keys/{api_key_id}, where {api_key_id} is the ID of the API key you want to update with the enabled property set to true or false for the API key.

REST 2.0 URL

Enable API Key Endpoint Address

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

https://api.vectara.io/v2/api_keys/:api_key_id

The API Reference shows the full Update API Key REST definition.

gRPC Example

You can find the full Update API Key gRPC definition at admin_apikey.proto.