List API Keys
curl --request POST \
--url https://api.example.com/list_api_brximport requests
url = "https://api.example.com/list_api_brx"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/list_api_brx', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/list_api_brx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/list_api_brx"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/list_api_brx")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/list_api_brx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"401": {},
"500": {},
"listKeyResponse": {
"keys": [
{
"name": "<string>",
"desc": "<string>",
"api_key": "<string>",
"access_perms": "<string>",
"createdAt": "<string>"
}
],
"total": 123
}
}API Key Management
List API Keys
Lists all API keys for the authenticated user
POST
/
list_api_brx
List API Keys
curl --request POST \
--url https://api.example.com/list_api_brximport requests
url = "https://api.example.com/list_api_brx"
response = requests.post(url)
print(response.text)const options = {method: 'POST'};
fetch('https://api.example.com/list_api_brx', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.example.com/list_api_brx",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://api.example.com/list_api_brx"
req, _ := http.NewRequest("POST", url, nil)
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.example.com/list_api_brx")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.example.com/list_api_brx")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
response = http.request(request)
puts response.read_body{
"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
object
Show properties
Show properties
array
number
Total number of API keys for the user
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
object
Unauthorized - Authentication credentials are missing or invalid
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_permsfield 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.