Get an API key

GET 
/v2/api_keys/:api_key_id

Returns an API key. The response shows the corpora the key can access and with what permissions.

Users that hold none of the corpus_administrator, administrator, or owner roles can only get 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 response includes the API key name, enabled status, API key role, and API policy.

403

The caller's roles do not allow getting 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.