List Api Keys — GET /api/v1/keys
List Api Keys
List active API keys. Non-admin users see only their own keys. ADMIN can filter by project_id to see all keys bound to a project.
Endpoint: GET /api/v1/keys
Authentication: Send a signed-in user’s access token in Authorization: Bearer <access token>, or an API key in X-API-Key: <API key>.
- Your role must be QA engineer or higher.
Parameters
Section titled “Parameters”| Name | In | Required | Type | Default | Description |
|---|---|---|---|---|---|
project_id | query | no | string (uuid) or null | Filter by project (ADMIN only) | |
X-API-Key | header | no | string or null | API key, as an alternative to the access token (see Authentication). |
Request body
Section titled “Request body”No request body.
Responses
Section titled “Responses”| Status | Meaning | Body |
|---|---|---|
200 | Successful Response | array of ApiKeyResponse (application/json) |
422 | Validation Error | HTTPValidationError (application/json) |
Errors this endpoint returns, read from its source code:
403, with the message “This API key is restricted to a different project”
It can also return 401 if your credential is missing or expired, 403 if your credential does not allow this request, and 404 if the item does not exist or you cannot see it. Your role, your project membership and the key’s scope decide what a credential allows. See Errors and retries.
More details
Section titled “More details”- Group: API Keys
- Operation ID:
list_api_keys_api_v1_keys_get - Source code:
backend/app/routers/api_keys.py, line 277 - Specification: OpenAPI JSON