Skip to main content
Version: 1.0

Enable API Key API Definition

The Enable 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.

keyEnablement Object​

The keyEnablement object contains pairs of a keyID with the enable status as true or false for the API key.

tip

Check out our interactive API Playground that lets you experiment with this REST endpoint to enable and disable API keys.

REST Example​

Enable API Key REST Endpoint Address​

Vectara exposes a REST endpoint at the following URL to enable API keys:
https://api.vectara.io/v1/enable-api-key

The API Playground shows the full Enable API Key REST definition.

gRPC Example​

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