Skip to main content
POST
/
delete_api_brx
{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "UpdateKeyResponse": {
    "deleted": true
  }
}
This endpoint deletes an API key for the authenticated user. Once deleted, the API key can no longer be used to authenticate API requests. This action cannot be undone, so use it with caution.

​
Request

​
apiKey
string
required
The API key to delete

​
Example Request

{
  "apiKey": "brx_api_12345678-90ab-cdef-1234-567890abcdef"
}

​
Response

​
UpdateKeyResponse
object

​
Example Response

{
  "UpdateKeyResponse": {
    "deleted": true
  }
}

​
Error Codes

​
400
object
Bad Request - The request was malformed or missing required parameters
​
401
object
Unauthorized - Authentication credentials are missing or invalid
​
403
object
Forbidden - The authenticated user does not have permission to delete the specified API key
​
404
object
Not Found - The specified API key does not exist or does not belong to the authenticated user
​
500
object
Internal Server Error - An unexpected error occurred on the server

​
Notes

  • Once an API key is deleted, it can no longer be used to authenticate API requests.
  • This action cannot be undone, so use it with caution.
  • You can only delete API keys that belong to your account.
  • If an API key is compromised, it should be deleted immediately to prevent unauthorized access.
  • To generate a new API key, use the Generate API Key endpoint.
  • To list all API keys for the authenticated user, use the List API Keys endpoint.