Update agent settings configuration

Updates the agent settings for service protection, browser extension deployment, and web tracking.

Endpoints

post /bsp/api/v1/bmp/agent/settings

Copy full URL

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/agent/settings

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Request Body

JSON body with agent settings grouped into service_settings, extension_settings, and comman_settings. All values are string booleans (0 or 1)

application/json

JSON object

Hide Sub-Attributes

service_settingsJSON objectOptional

Agent service protection settings to update

Show Sub-Attributes

disable_agent_uninstall_bspstringOptional

Prevent agent uninstallation. '0'=allow, '1'=prevent

disable_agent_modify_bspstringOptional

Prevent agent modification. '0'=allow, '1'=prevent

disable_agent_stop_service_bspstringOptional

Prevent agent service stop. '0'=allow, '1'=prevent

extension_settingsJSON objectOptional

Browser extension deployment settings to update

Show Sub-Attributes

chrome_extension_bspstringOptional

Enable Chrome extension deployment. '0'=disable, '1'=deploy

firefox_extension_bspstringOptional

Enable Firefox extension deployment. '0'=disable, '1'=deploy

edge_extension_bspstringOptional

Enable Edge extension deployment. '0'=disable, '1'=deploy

enable_bho_bspstringOptional

Enable Browser Helper Object. '0'=disable, '1'=enable

chromium_extension_bspstringOptional

Enable Chromium extension deployment. '0'=disable, '1'=deploy

ulaa_extension_bspstringOptional

Enable Ulaa extension deployment. '0'=disable, '1'=deploy

comman_settingsJSON objectOptional

Common tracking settings to update

Show Sub-Attributes

enable_web_tracking_bspstringOptional

Enable web activity tracking. '0'=disable, '1'=enable

enable_intranet_web_tracking_bspstringOptional

Enable intranet web activity tracking. '0'=disable, '1'=enable

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/agent/settings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"service_settings":{"disable_agent_modify_bsp":"1","disable_agent_uninstall_bsp":"1","disable_agent_stop_service_bsp":"0"},"comman_settings":{"enable_web_tracking_bsp":"1","enable_intranet_web_tracking_bsp":"0"},"extension_settings":{"firefox_extension_bsp":"1","chrome_extension_bsp":"1","enable_bho_bsp":"0","edge_extension_bsp":"1","chromium_extension_bsp":"1","ulaa_extension_bsp":"1"}}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomain/bsp/api/v1/bmp/agent/settings"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"service_settings\":{\"disable_agent_modify_bsp\":\"1\",\"disable_agent_uninstall_bsp\":\"1\",\"disable_agent_stop_service_bsp\":\"0\"},\"comman_settings\":{\"enable_web_tracking_bsp\":\"1\",\"enable_intranet_web_tracking_bsp\":\"0\"},\"extension_settings\":{\"firefox_extension_bsp\":\"1\",\"chrome_extension_bsp\":\"1\",\"enable_bho_bsp\":\"0\",\"edge_extension_bsp\":\"1\",\"chromium_extension_bsp\":\"1\",\"ulaa_extension_bsp\":\"1\"}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomain")

payload = "{\"service_settings\":{\"disable_agent_modify_bsp\":\"1\",\"disable_agent_uninstall_bsp\":\"1\",\"disable_agent_stop_service_bsp\":\"0\"},\"comman_settings\":{\"enable_web_tracking_bsp\":\"1\",\"enable_intranet_web_tracking_bsp\":\"0\"},\"extension_settings\":{\"firefox_extension_bsp\":\"1\",\"chrome_extension_bsp\":\"1\",\"enable_bho_bsp\":\"0\",\"edge_extension_bsp\":\"1\",\"chromium_extension_bsp\":\"1\",\"ulaa_extension_bsp\":\"1\"}}"

headers = {
    'Content-Type': "application/json",
    'Accept': "application/json",
    'Authorization': " d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/bsp/api/v1/bmp/agent/settings", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Content-Type", "application/json");
    headersMap.put("Accept", "application/json");

    data=Map();
    data_service_settings=Map();
    data_service_settings.put("disable_agent_uninstall_bsp","value");
    data_service_settings.put("disable_agent_modify_bsp","value");
    data_service_settings.put("disable_agent_stop_service_bsp","value");
    data.put("service_settings",data_service_settings);
    data_extension_settings=Map();
    data_extension_settings.put("chrome_extension_bsp","value");
    data_extension_settings.put("firefox_extension_bsp","value");
    data_extension_settings.put("edge_extension_bsp","value");
    data_extension_settings.put("enable_bho_bsp","value");
    data_extension_settings.put("chromium_extension_bsp","value");
    data_extension_settings.put("ulaa_extension_bsp","value");
    data.put("extension_settings",data_extension_settings);
    data_comman_settings=Map();
    data_comman_settings.put("enable_web_tracking_bsp","value");
    data_comman_settings.put("enable_intranet_web_tracking_bsp","value");
    data.put("comman_settings",data_comman_settings);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/agent/settings"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Content-Type", "application/json")
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/bsp/api/v1/bmp/agent/settings' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"service_settings":{"disable_agent_modify_bsp":"1","disable_agent_uninstall_bsp":"1","disable_agent_stop_service_bsp":"0"},"comman_settings":{"enable_web_tracking_bsp":"1","enable_intranet_web_tracking_bsp":"0"},"extension_settings":{"firefox_extension_bsp":"1","chrome_extension_bsp":"1","enable_bho_bsp":"0","edge_extension_bsp":"1","chromium_extension_bsp":"1","ulaa_extension_bsp":"1"}}'

▼ Show full

Sample Request Body

Update all agent Settings

Copied!

  {
    "service_settings": {
      "disable_agent_modify_bsp": "1",
      "disable_agent_uninstall_bsp": "1",
      "disable_agent_stop_service_bsp": "0"
    },
    "comman_settings": {
      "enable_web_tracking_bsp": "1",
      "enable_intranet_web_tracking_bsp": "0"
    },
    "extension_settings": {
      "firefox_extension_bsp": "1",
      "chrome_extension_bsp": "1",
      "enable_bho_bsp": "0",
      "edge_extension_bsp": "1",
      "chromium_extension_bsp": "1",
      "ulaa_extension_bsp": "1"
    }
  }

▼ Show full

Response Parameters

- HTTP code 204

Response Body - application/json

500HTTP code

Sample Response: HTTP 204

Copied!

204 Returns 204 No Content on success.

▼ Show full

Sample Response: HTTP 401

Authentication credentials are missing or invalid

Copied!

  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }

▼ Show full

Sample Response: HTTP 403

The user does not have the required permissions to perform this action

Copied!

  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }

▼ Show full

Sample Response: HTTP 429

Too many API requests have been made

Copied!

  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
  }

▼ Show full

Sample Response: HTTP 500

An unexpected server error occurred

Copied!

  {
    "error_description": "Internal Server error, Please try again in a moment.",
    "error_code": "COM0004"
  }

▼ Show full

Duration: 1 minute | Threshold: 60 | Lock period: 5 minutes

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.