/api-key

Returns all API keys for the authenticated user.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

List API Keys

Use this route to retrieve all API keys associated with the authenticated user. The response includes metadata for each key such as its masked value, assigned permissions, and creation details.

Response

Returns an array of API key objects. For security reasons, the full API key value (key) is only returned once, at creation time via POST /api-key. This listing endpoint only returns the masked version (key_mask). If you lose the original key, you must delete it and create a new one.

[
  {
    "id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "key_mask": "ddf_ak_abc...890",
    "permissions": [
      { "id": 1, "name": "catalog:read" },
      { "id": 2, "name": "catalog:write" }
    ],
    "created_at": "2025-01-15T10:30:00.000Z",
    "created_by": "[email protected]"
  }
]

Error scenarios

CodeErrorDescription
401UnauthenticatedInvalid or missing access-token header
403ForbiddenUser does not have permission to list API keys
500Internal Server ErrorUnknown server error
Headers
string
enum
Allowed:
Response

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json