Skip to main content
POST
/
list_api_brx
{
  "401": {},
  "500": {},
  "listKeyResponse": {
    "keys": [
      {
        "name": "<string>",
        "desc": "<string>",
        "api_key": "<string>",
        "access_perms": "<string>",
        "createdAt": "<string>"
      }
    ],
    "total": 123
  }
}
This endpoint lists all API keys for the authenticated user. It returns information about each API key, including its name, description, creation date, and access permissions. The actual API key values are not returned for security reasons.

​
Request

This endpoint does not require any parameters.

​
Example Request

{}

​
Response

​
listKeyResponse
object

​
Example Response

{
  "listKeyResponse": {
    "keys": [
      {
        "name": "Production API Key",
        "desc": "Used for production server integration",
        "api_key": "brx_api_1234...abcdef",
        "access_perms": "read-only",
        "createdAt": "2023-01-01T00:00:00.000Z"
      },
      {
        "name": "Development API Key",
        "desc": "Used for development and testing",
        "api_key": "brx_api_5678...ghijkl",
        "access_perms": "read-write",
        "createdAt": "2023-01-02T00:00:00.000Z"
      }
    ],
    "total": 2
  }
}

​
Example Response (No API Keys)

{
  "listKeyResponse": {
    "keys": [],
    "total": 0
  }
}

​
Error Codes

​
401
object
Unauthorized - Authentication credentials are missing or invalid
​
500
object
Internal Server Error - An unexpected error occurred on the server

​
Notes

  • This endpoint returns information about all API keys for the authenticated user.
  • The actual API key values are not returned for security reasons. Instead, a masked version of each API key is returned for display purposes.
  • The access_perms field indicates the access permissions for the API key, such as “read-only” or “read-write”.
  • To generate a new API key, use the Generate API Key endpoint.
  • To delete an API key, use the Delete API Key endpoint.