List API keys
Changed onList API keys. Returns metadata for each key (id, name, description, key_type, status, redacted_key, created_at, expires_at, created_by_user_id). The raw key secret is never returned after creation.
Results can be filtered by key type, status, space, and creator. Responses are paginated; use limit and cursor and the response pagination.next_cursor for subsequent pages.
Service keys (key_type=SERVICE): Provide space_id to return all service keys for that space. When key_type is omitted alongside space_id, service keys are returned implicitly. Requires the SERVICE_KEY_READ permission in the space (or account/space admin). Optionally combine with user_id to filter service keys by their creator — available to any caller with space access (not admin-gated). Each service key entry includes bot_user, with the same fields as the bot user returned by POST /v2/api-keys — use bot_user.id as the user_id when creating a role binding for the key. Unlike the create response, bot_user.organizations may be empty in a list response:
- When space_id is set, bot_user.organizations is always empty, including for the queried space. The bot user may hold bindings in spaces or organizations the caller cannot read, so the space-scoped listing returns no bindings.
- When the bot user cannot be resolved (for example, it was deleted while the list ran), bot_user.name is empty, bot_user.organizations is empty, and bot_user.account_role is a MEMBER placeholder, not the bot user's real role. Do not make role decisions from account_role when name is empty.
User keys (key_type=USER): Returned by default (no space_id). Provide user_id to view keys belonging to a specific user — account admins only; non-admins receive 403.
<Note>This endpoint is in beta, read more here.</Note>
Request
- Base URLhttps://api.arize.com
- URLhttps://api.arize.com/v2/api-keys
- AuthHTTP bearer
Query parameters
Type of the API key.
- USER - Personal key that authenticates as the creating user.
- SERVICE - Key that authenticates as a service account with explicitly granted access.
Filter by API key type.
- USER - Key associated with a specific user.
- SERVICE - Key associated with a bot user for service authentication.
Current status of the API key.
- ACTIVE - The key is valid for use.
- REVOKED - The key has been revoked and is no longer valid.
Filter by API key status.
- ACTIVE - Only return keys that are valid for use.
- REVOKED - Only return keys that have been revoked.
When not specified, defaults to ACTIVE.
A universally unique identifier (base64-encoded opaque string).
Filter search results to a particular space ID
A universally unique identifier (base64-encoded opaque string).
Filter results by user (base64 global user ID). When provided, only records associated with this user are returned. Access requirements vary by endpoint — some endpoints restrict this filter to account admins.
Maximum items to return. Defaults to 50 if omitted; maximum is 100.
Opaque pagination cursor returned from a previous response (pagination.next_cursor). Treat it as an unreadable token; do not attempt to parse or construct it.
Response
Returns a list of API keys matching the request filters. The raw key secret is never returned.
Changes
- warning
added the new
MEMBER_UI_ONLYenum value to the////////////////response property for the response status
- warning
- breaking
added to the
/response propertyoneOflist for the response status - breaking
the
/response's property type changed fromobjectto no type for status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - breaking
removed the required property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - warning
removed the optional property
//from the response with the status - info
added discriminator to
/response property for the response status
- breaking