Get an API key
One key’s metadata, state, and scopes. The token is not here, by design.
spec.token is omitted on every read. That is the security model, not an oversight. If you need the raw value again, rotate.
objectives:manage absorbs objectives:read. See how scopes work.
Related
List API keys
Rotate an API key
Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
The workspace the API key belongs to (path).
"workspace_01HXKD2E5NQM3T9AYWCF133E3Q"
The API key to retrieve.
"apikey_01HXKD2E5NQM3T9AYWCFCSPNQY"
Response
OK
An API key. Every key belongs to exactly one workspace and is managed via the workspace-scoped API key routes. The only exception is the system-managed global account key, which spans all workspaces and is managed via the account global_api_key routes.
AccountResourceMetadata is used to represent a resource that is associated to an account but not to a workspace.
Configuration for an API key.
The current lifecycle state of the API key. Output only. Keys are created STATE_ENABLED; use the :disable and :enable actions to transition between states.
STATE_UNSPECIFIED, STATE_ENABLED, STATE_DISABLED