Navigation policies
List Navigation Policies
List the project’s navigation policies, ordered by name.
GET
/
v1
/
navigation-policies
Node.js
import Browserbase from "@browserbasehq/sdk";
const bb = new Browserbase({
apiKey: process.env.BROWSERBASE_API_KEY,
});
const { data: policies } = await bb.navigationPolicies.list();
for (const policy of policies) {
console.log(policy.id, policy.name);
}import os
from browserbase import Browserbase
bb = Browserbase(api_key=os.environ["BROWSERBASE_API_KEY"])
policies = bb.navigation_policies.list().data
for policy in policies:
print(policy.id, policy.name)curl --request GET \
--url https://api.browserbase.com/v1/navigation-policies \
--header "X-BB-API-Key: $BROWSERBASE_API_KEY"<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.browserbase.com/v1/navigation-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-BB-API-Key: <api-key>"
],
]);
$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.browserbase.com/v1/navigation-policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BB-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.browserbase.com/v1/navigation-policies")
.header("X-BB-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.browserbase.com/v1/navigation-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"projectId": "<string>",
"name": "<string>",
"description": "<string>",
"enabled": true,
"defaultDecision": "allow",
"allowedCategories": [
"adult"
],
"blockedCategories": [
"adult"
],
"unknownDomainBehavior": "allow",
"domainOverrides": [
{
"domain": "<string>",
"decision": "allow"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}Authorizations
Your Browserbase API Key.
Was this page helpful?
⌘I
Node.js
import Browserbase from "@browserbasehq/sdk";
const bb = new Browserbase({
apiKey: process.env.BROWSERBASE_API_KEY,
});
const { data: policies } = await bb.navigationPolicies.list();
for (const policy of policies) {
console.log(policy.id, policy.name);
}import os
from browserbase import Browserbase
bb = Browserbase(api_key=os.environ["BROWSERBASE_API_KEY"])
policies = bb.navigation_policies.list().data
for policy in policies:
print(policy.id, policy.name)curl --request GET \
--url https://api.browserbase.com/v1/navigation-policies \
--header "X-BB-API-Key: $BROWSERBASE_API_KEY"<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.browserbase.com/v1/navigation-policies",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"X-BB-API-Key: <api-key>"
],
]);
$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.browserbase.com/v1/navigation-policies"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("X-BB-API-Key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.browserbase.com/v1/navigation-policies")
.header("X-BB-API-Key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.browserbase.com/v1/navigation-policies")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["X-BB-API-Key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"data": [
{
"id": "<string>",
"projectId": "<string>",
"name": "<string>",
"description": "<string>",
"enabled": true,
"defaultDecision": "allow",
"allowedCategories": [
"adult"
],
"blockedCategories": [
"adult"
],
"unknownDomainBehavior": "allow",
"domainOverrides": [
{
"domain": "<string>",
"decision": "allow"
}
],
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z"
}
]
}