v2

latestOpenAPI 3.0.02026-08-051996591.2 MB

API Keys

Update an API key

Updates an API key. Enable or disable the key to temporarily remove access without deleting the key. This is useful for maintenance windows, or when your team no longer requires access to a specific corpus.

patch/v2/api_keys/{api_key_id}

Path parameters

api_key_idstring required

The ID of the API key.

Headers

Request-Timeoutinteger

The platform makes a best effort to complete the request in the specified seconds, or it times out.

Request-Timeout-Millisinteger

The platform makes a best effort to complete the request in the specified milliseconds, or it times out.

Request body

enabledboolean

Indicates whether to disable or enable an API key.

Response

The API key.

idstring required

The ID of the API key.

namestring required

The human-readable name of the API key.

secret_keystring required

The key used in API requests. Keep the key secure.

enabledboolean

Indicates whether the API key is enabled.

api_rolesApiRole[]

Customer-level roles for this API key.

api_key_role'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.