Update an API key

PATCH 
/v2/api_keys/:api_key_id

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.

Users that hold none of the corpus_administrator, administrator, or owner roles can only update their own personal API key; a key that exists but belongs to another user returns a 404 error. Machine credentials — API keys, app clients, and service accounts — without one of those three roles cannot call this operation.

Request

Responses

200

The API key.

403

The caller's roles do not allow updating API keys. A machine credential — an API key, app client, or service account — that holds none of the corpus_administrator, administrator, or owner roles is always refused.

404

No API key with this ID is visible to the caller.