Get a Navigation Policy

GET

navigation-policies

{id}

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const policy = await bb.navigationPolicies.retrieve("<policy-id>");

console.log(policy.domainOverrides);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/navigation-policies/{id}",
  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/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/navigation-policies/{id}")

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

{
  "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

X-BB-API-Key

string

header

required

Your Browserbase API Key.

Path Parameters

string<uuid>

required

The navigation policy ID.

Response

200 - application/json

The navigation policy.

Rules for which domains a browser session may navigate to. Bind a policy to a session with browserSettings.riskPolicyId; Browserbase then allows or blocks each navigation by the policy's overrides, its category rules, and finally its default decision. A session keeps the policy as it was when the session started: edits, disables, and deletes apply to sessions that start afterwards. A policy checks navigations: page loads, iframes, popups, and each redirect. It doesn't check requests a page makes itself, such as scripts, images, and fetch calls. In a session that loads a Context, pages skip their service workers so that the policy checks every navigation.

string

required

Unique identifier for the navigation policy.

projectId

string

required

The project the policy belongs to.

name

string

required

Display name. A policy's id identifies it, not its name.

Required string length: 1 - 128

description

string

required

Free-form notes about the policy.

Maximum string length: 1024

enabled

boolean

required

Whether the policy can be bound to new sessions. Running sessions keep the policy they started with. A disabled policy stays editable and can be re-enabled.

defaultDecision

enum<string>

required

Decision for each of a domain's categories that has no category rule. The strictest of a domain's category decisions applies, and overrides take precedence.

Available options:

allow,

block

allowedCategories

enum<string>[]

required

Navigation categories. Browserbase blocks a domain in any blocked category, even if it is also in an allowed one.

Available options:

adult,

ai-tools,

alcohol-tobacco,

business,

child-abuse,

communication,

dating,

drugs,

education,

entertainment,

finance,

gambling,

games,

government-military,

hacking,

hate,

health,

illegal-activity,

infrastructure,

kids,

lifestyle,

malware,

newly-registered,

news,

parked-inactive,

phishing-scams,

piracy,

proxy-anonymizer,

search-portal,

self-harm,

shopping,

social-media,

society-culture,

sports,

technology,

terrorism-extremism,

travel,

url-shortener,

violence,

weapons

blockedCategories

enum<string>[]

required

Navigation categories. Browserbase blocks a domain in any blocked category, even if it is also in an allowed one.

Available options:

adult,

ai-tools,

alcohol-tobacco,

business,

child-abuse,

communication,

dating,

drugs,

education,

entertainment,

finance,

gambling,

games,

government-military,

hacking,

hate,

health,

illegal-activity,

infrastructure,

kids,

lifestyle,

malware,

newly-registered,

news,

parked-inactive,

phishing-scams,

piracy,

proxy-anonymizer,

search-portal,

self-harm,

shopping,

social-media,

society-culture,

sports,

technology,

terrorism-extremism,

travel,

url-shortener,

violence,

weapons

unknownDomainBehavior

enum<string>

required

Decision for a domain, or one of its categories, that Browserbase can't classify. It counts as one of the domain's category decisions, so the strictest still applies.

Available options:

allow,

block

domainOverrides

object[]

required

Per-host decisions that take precedence over category rules and the default. Each host may appear once.

Maximum array length: 500

Show child attributes

createdAt

string<date-time>

required

updatedAt

string<date-time>

required

⌘I

Node.js

import Browserbase from "@browserbasehq/sdk";

const bb = new Browserbase({
  apiKey: process.env.BROWSERBASE_API_KEY,
});

const policy = await bb.navigationPolicies.retrieve("<policy-id>");

console.log(policy.domainOverrides);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.browserbase.com/v1/navigation-policies/{id}",
  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/{id}"

	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))

}

require 'uri'
require 'net/http'

url = URI("https://api.browserbase.com/v1/navigation-policies/{id}")

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

{
  "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"
}

Overview

SDKs

APIs

Authorizations

Path Parameters

Response