Check BRK ACL

curl --request POST \
  --url https://api.example.com/check_brx_acl \
  --header 'Content-Type: application/json' \
  --data '
{
  "brxId": "<string>"
}
'

import requests

url = "https://api.example.com/check_brx_acl"

payload = { "brxId": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({brxId: '<string>'})
};

fetch('https://api.example.com/check_brx_acl', 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/check_brx_acl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'brxId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/check_brx_acl"

	payload := strings.NewReader("{\n  \"brxId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/check_brx_acl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brxId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": true,
      "isClone": true,
      "brxId": "<string>",
      "emails": [
        {
          "email": "<string>",
          "permission": 123
        }
      ]
    }
  }
}

POST

check_brx_acl

Check BRK ACL

curl --request POST \
  --url https://api.example.com/check_brx_acl \
  --header 'Content-Type: application/json' \
  --data '
{
  "brxId": "<string>"
}
'

import requests

url = "https://api.example.com/check_brx_acl"

payload = { "brxId": "<string>" }
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({brxId: '<string>'})
};

fetch('https://api.example.com/check_brx_acl', 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/check_brx_acl",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'brxId' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/check_brx_acl"

	payload := strings.NewReader("{\n  \"brxId\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.example.com/check_brx_acl")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"brxId\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "400": {},
  "401": {},
  "403": {},
  "404": {},
  "500": {},
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": true,
      "isClone": true,
      "brxId": "<string>",
      "emails": [
        {
          "email": "<string>",
          "permission": 123
        }
      ]
    }
  }
}

This endpoint retrieves the access control list (ACL) for a BRK. It allows you to check the visibility of a BRK (public or private), whether it can be cloned, and the list of users who have access to it along with their permission levels. You must have at least viewer permissions for the BRK to access its ACL.

Request

string

required

The ID of the BRK to check ACL for

Example Request

{
  "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef"
}

Response

object

Show properties

object

Show properties

boolean

Indicates whether the BRK is public (visible to all users) or private (visible only to specified users)

boolean

Indicates whether the BRK can be cloned by other users

string

The ID of the BRK

array

Array of user email addresses and their permission levels

Show items

string

Email address of the user

number

Permission level for the user. 0: Viewer (can view and execute the BRK), 1: Editor (can view, execute, and edit the BRK), 2: Owner (can view, execute, edit, and delete the BRK, as well as manage permissions)

Example Response (Private BRK)

{
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": false,
      "isClone": true,
      "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
      "emails": [
        {
          "email": "owner@example.com",
          "permission": 2
        },
        {
          "email": "editor@example.com",
          "permission": 1
        },
        {
          "email": "viewer@example.com",
          "permission": 0
        }
      ]
    }
  }
}

Example Response (Public BRK)

{
  "getBrxACLResponse": {
    "brxs": {
      "isPublic": true,
      "isClone": true,
      "brxId": "brk-12345678-90ab-cdef-1234-567890abcdef",
      "emails": [
        {
          "email": "owner@example.com",
          "permission": 2
        }
      ]
    }
  }
}

Error Codes

object

Bad Request - The request was malformed or missing required parameters

object

Unauthorized - Authentication credentials are missing or invalid

object

Forbidden - The authenticated user does not have permission to check the ACL for the requested BRK

object

Not Found - The requested BRK does not exist

object

Internal Server Error - An unexpected error occurred on the server

Notes

You must have at least viewer permissions for the BRK to access its ACL.
The response includes the visibility of the BRK (isPublic), whether it can be cloned (isClone), and the list of users who have access to it along with their permission levels.
Permission levels:
- 0: Viewer (can view and execute the BRK)
- 1: Editor (can view, execute, and edit the BRK)
- 2: Owner (can view, execute, edit, and delete the BRK, as well as manage permissions)
To update the ACL for a BRK, use the Update BRK ACL endpoint.

API Documentation

BRK Management

BRK Execution

Access Control

API Key Management

Check BRK ACL

Request

Example Request

Response

Example Response (Private BRK)

Example Response (Public BRK)

Error Codes

Notes

​Request

​Example Request

​Response

​Example Response (Private BRK)

​Example Response (Public BRK)

​Error Codes

​Notes

Request

Example Request

Response

Example Response (Private BRK)

Example Response (Public BRK)

Error Codes

Notes