List Policies - Barndoor Documentation
List Policies
cURL
curl --request GET \
--url 'https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10' \
--header 'Authorization: Bearer <token>'
Python
import requests
url = "https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)
JavaScript (Fetch)
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
PHP
<?php
$curl = curl_init();
curl_setopt_array($curl, [\
CURLOPT_URL => "https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10",\
CURLOPT_RETURNTRANSFER => true,\
CURLOPT_ENCODING => "",\
CURLOPT_MAXREDIRS => 10,\
CURLOPT_TIMEOUT => 30,\
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,\
CURLOPT_CUSTOMREQUEST => "GET",\
CURLOPT_HTTPHEADER => [\
"Authorization: Bearer <token>"\
],\
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
?>
Go
package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}
Unirest (Java)
HttpResponse<String> response = Unirest.get("https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10")
.header("Authorization", "Bearer <token>")
.asString();
Ruby
require 'uri'
require 'net/http'
url = URI("https://your-org.platform.barndoor.ai/api/v2/policies?page=1&limit=10")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body
Success Response
Status Codes: 200, 422
{
"data": [
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>",
"status": "<string>",
"mcp_server_id": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"updated_by_user_id": "<string>",
"mcp_server_name": "<string>",
"application_ids": [
"<string>"
],
"application_names": [
"<string>"
],
"tags": [
"<string>"
],
"updated_by_user_name": "<string>",
"description": "<string>",
"rules_count": 0
}
],
"pagination": {
"page": 123,
"limit": 123,
"total": 123,
"pages": 123,
"previous_page": 123,
"next_page": 123
}
}
Error Response
{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}
Authorizations
Authorization
- Type:
string - Location:
header - Required: Yes
- Description: Bearer authentication header of the form
Bearer <token>, where<token>is your auth token.
Query Parameters
search:string | null- Search by policy ID, name, description, or support contactstatus:string[] | null- Filter by status valuesmcp_server_id:string[] | null- Filter by MCP server IDsagent_id:string[] | null- Filter by agent/application IDspage:integer- Page number (1-based), default: 1limit:integer- Number of items per page (max 100), default: 10
Response
Success Response
- Status: 200
- Content-Type: application/json
- Description: Successful Response
- Schema:
data: PolicySummary · object[] - Array of items for current pagepagination: PaginationMeta · object - Pagination metadata