Add a browser-specific payload configuration

Adds a browser-specific add-on payload to an add-on management profile. Payloads cannot be added to a published profile.

Endpoints

post /bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads

Copy full URL

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory

application/jsonCopied!

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

addon_idstringMandatory

Add-On Management Profile ID from List Add-On Management Profiles response (manage_addon_id field)

- Request Body

JSON body with payload configuration. Uses flat format: addon_payloads contains payload_type and browser_type directly. Each browser type has different supported keys refer to the examples below

application/json

JSON Object

Add-on payload. Pick a browser from the dropdown

Hide Sub-Attributes

addon_payloadsOptional

Browser-specific payload

Show Sub-Attributes

oneOf

Examples

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"restrict_permissions":1,"payload_type":64125,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":1,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]},"install_addons":["30"]}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64125,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":1,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]},\"install_addons\":[\"30\"]}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64125,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":1,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]},\"install_addons\":[\"30\"]}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"restrict_permissions":1,"payload_type":64125,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":1,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]},"install_addons":["30"]}}'

Sample Request Body - Google Chrome

Chrome payload (browser_type=1)

Copied!

  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64125,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [
        "10"
      ],
      "browser_type": 1,
      "policies": {
        "disable_user_extensions": "1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      },
      "install_addons": [
        "30"
      ]
    }
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"payload_type":64127,"restrict_domains":-1,"browser_type":2,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"13"}],"restrict_addons":"1","install_addons":["13"]}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"payload_type\":64127,\"restrict_domains\":-1,\"browser_type\":2,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"13\"}],\"restrict_addons\":\"1\",\"install_addons\":[\"13\"]}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"payload_type\":64127,\"restrict_domains\":-1,\"browser_type\":2,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"13\"}],\"restrict_addons\":\"1\",\"install_addons\":[\"13\"]}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"payload_type":64127,"restrict_domains":-1,"browser_type":2,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"13"}],"restrict_addons":"1","install_addons":["13"]}}'

Sample Request Body - Mozilla Firefox

Firefox payload (browser_type=2). No permissions, native_hosts, or pinned_addons.

Copied!

  {
    "addon_payloads": {
      "payload_type": 64127,
      "restrict_domains": -1,
      "browser_type": 2,
      "policies": {
        "disable_user_extensions": "1"
      },
      "add_ons": [
        {
          "binary_id": "13"
        }
      ],
      "restrict_addons": "1",
      "install_addons": [
        "13"
      ]
    }
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"restrict_permissions":1,"payload_type":64907,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":5,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]},"install_addons":["30"]}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64907,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":5,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]},\"install_addons\":[\"30\"]}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64907,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":5,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]},\"install_addons\":[\"30\"]}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"restrict_permissions":1,"payload_type":64907,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":5,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]},"install_addons":["30"]}}'

Sample Request Body - Microsoft Edge

Edge payload (browser_type=5). Same shape as Chrome; uses Edge-specific binary_ids.

Copied!

  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64907,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [
        "10"
      ],
      "browser_type": 5,
      "policies": {
        "disable_user_extensions": "1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      },
      "install_addons": [
        "30"
      ]
    }
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"restrict_permissions":1,"payload_type":64459,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":31,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]}}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64459,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":31,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]}}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64459,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":31,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]}}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"restrict_permissions":1,"payload_type":64459,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":31,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]}}}'

Sample Request Body - Ulaa

Ulaa payload (browser_type=31). Same shape as Chrome; shares Chrome's extension store.

Copied!

  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64459,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [
        "10"
      ],
      "browser_type": 31,
      "policies": {
        "disable_user_extensions": "1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      }
    }
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"restrict_permissions":1,"payload_type":64409,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":1024,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]}}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64409,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":1024,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]}}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"restrict_permissions\":1,\"payload_type\":64409,\"runtime_addons\":[],\"restrict_domains\":-1,\"pinned_addons\":[\"30\"],\"permissions\":[\"10\"],\"browser_type\":1024,\"policies\":{\"disable_user_extensions\":\"1\"},\"add_ons\":[{\"binary_id\":\"30\"}],\"restrict_addons\":\"1\",\"native_hosts\":{\"native_permission\":\"-1\",\"native_ids\":[]}}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"restrict_permissions":1,"payload_type":64409,"runtime_addons":[],"restrict_domains":-1,"pinned_addons":["30"],"permissions":["10"],"browser_type":1024,"policies":{"disable_user_extensions":"1"},"add_ons":[{"binary_id":"30"}],"restrict_addons":"1","native_hosts":{"native_permission":"-1","native_ids":[]}}}'

Sample Request Body - Other Chromium

Other Chromium payload (browser_type=1024). Same shape as Chrome plus applicable_browsers array.

Copied!

  {
    "addon_payloads": {
      "restrict_permissions": 1,
      "payload_type": 64409,
      "runtime_addons": [],
      "restrict_domains": -1,
      "pinned_addons": [
        "30"
      ],
      "permissions": [
        "10"
      ],
      "browser_type": 1024,
      "policies": {
        "disable_user_extensions": "1"
      },
      "add_ons": [
        {
          "binary_id": "30"
        }
      ],
      "restrict_addons": "1",
      "native_hosts": {
        "native_permission": "-1",
        "native_ids": []
      }
    }
  }

▼ Show full

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"addon_payloads":{"restrict_permissions":-1,"payload_type":64126,"restrict_domains":-1,"permissions":[],"browser_type":3,"policies":{"turn_off_blocking_outdated_addon":"1","restrict_activex":"0","remove_run_this_time":"0","enable_extensions":"1"},"add_ons":[],"restrict_addons":"0"}}'

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/manage_addons/{addon_id}/addon_payloads"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{\"addon_payloads\":{\"restrict_permissions\":-1,\"payload_type\":64126,\"restrict_domains\":-1,\"permissions\":[],\"browser_type\":3,\"policies\":{\"turn_off_blocking_outdated_addon\":\"1\",\"restrict_activex\":\"0\",\"remove_run_this_time\":\"0\",\"enable_extensions\":\"1\"},\"add_ons\":[],\"restrict_addons\":\"0\"}}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{\"addon_payloads\":{\"restrict_permissions\":-1,\"payload_type\":64126,\"restrict_domains\":-1,\"permissions\":[],\"browser_type\":3,\"policies\":{\"turn_off_blocking_outdated_addon\":\"1\",\"restrict_activex\":\"0\",\"remove_run_this_time\":\"0\",\"enable_extensions\":\"1\"},\"add_ons\":[],\"restrict_addons\":\"0\"}}"

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

conn.request("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads", 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_addon_payloads=Map();
    data_addon_payloads.put("payload_type","value");
    data_addon_payloads.put("browser_type","value");
    data_addon_payloads.put("restrict_addons","value");
    data_addon_payloads_add_ons=List();
    data_addon_payloads_add_ons_item1=Map();
    data_addon_payloads_add_ons_item1.put("binary_id","value");
    data_addon_payloads_add_ons_item1.put("install_type","value");
    data_addon_payloads_add_ons.add(data_addon_payloads_add_ons_item1);
    data_addon_payloads.put("add_ons",data_addon_payloads_add_ons);
    data_addon_payloads.put("restrict_domains","value");
    data_addon_payloads_policies=Map();
    data_addon_payloads_policies.put("disable_user_extensions",true);
    data_addon_payloads_policies.put("disable_developer_mode",true);
    data_addon_payloads.put("policies",data_addon_payloads_policies);
    data_addon_payloads.put("restrict_permissions","value");
    data_addon_payloads_permissions=List();
    data_addon_payloads.put("permissions",data_addon_payloads_permissions);
    data_addon_payloads_native_hosts=Map();
    data_addon_payloads_native_hosts_allowed_hosts=List();
    data_addon_payloads_native_hosts.put("allowed_hosts",data_addon_payloads_native_hosts_allowed_hosts);
    data_addon_payloads_native_hosts_blocked_hosts=List();
    data_addon_payloads_native_hosts.put("blocked_hosts",data_addon_payloads_native_hosts_blocked_hosts);
    data_addon_payloads.put("native_hosts",data_addon_payloads_native_hosts);
    data_addon_payloads_pinned_addons=List();
    data_addon_payloads.put("pinned_addons",data_addon_payloads_pinned_addons);
    data_addon_payloads_install_addons=List();
    data_addon_payloads.put("install_addons",data_addon_payloads_install_addons);
    data_addon_payloads_runtime_addons=List();
    data_addon_payloads_runtime_addons_item1=Map();
    data_addon_payloads_runtime_addons_item1.put("site_allow","value");
    data_addon_payloads_runtime_addons_item1_binary_ids=List();
    data_addon_payloads_runtime_addons_item1.put("binary_ids",data_addon_payloads_runtime_addons_item1_binary_ids);
    data_addon_payloads_runtime_addons_item1_site_groups=List();
    data_addon_payloads_runtime_addons_item1.put("site_groups",data_addon_payloads_runtime_addons_item1_site_groups);
    data_addon_payloads_runtime_addons.add(data_addon_payloads_runtime_addons_item1);
    data_addon_payloads.put("runtime_addons",data_addon_payloads_runtime_addons);
    data.put("addon_payloads",data_addon_payloads);

    response = invokeUrl
    [
        url: "https://appDomain/bsp/api/v1/bmp/manage_addons/{addon_id}/addon_payloads"
        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/manage_addons/{addon_id}/addon_payloads' -Method POST -Headers $headers -ContentType 'application/json' -Body '{"addon_payloads":{"restrict_permissions":-1,"payload_type":64126,"restrict_domains":-1,"permissions":[],"browser_type":3,"policies":{"turn_off_blocking_outdated_addon":"1","restrict_activex":"0","remove_run_this_time":"0","enable_extensions":"1"},"add_ons":[],"restrict_addons":"0"}}'

Sample Request Body - Internet Explorer

IE payload (browser_type=3). Uses IE-specific policies; no permissions, native_hosts, or pinned_addons.

Copied!

  {
    "addon_payloads": {
      "restrict_permissions": -1,
      "payload_type": 64126,
      "restrict_domains": -1,
      "permissions": [],
      "browser_type": 3,
      "policies": {
        "turn_off_blocking_outdated_addon": "1",
        "restrict_activex": "0",
        "remove_run_this_time": "0",
        "enable_extensions": "1"
      },
      "add_ons": [],
      "restrict_addons": "0"
    }
  }

▼ Show full

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

addon_payloads

Newly added payload configurations. Schema branches by target browser

Show Sub-Attributes

oneOf

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json

JSON Object

Hide Sub-Attributes

errormsgstring

Message indicating the requested resource was not found

- HTTP code 409

Response Body - application/json

JSON Object

Hide Sub-Attributes

errormsgstring

Message indicating a published profile cannot be modified

- HTTP code 429

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json

JSON Object

Hide Sub-Attributes

errormsgstring

Message describing the internal server error

Possible Response Codes

200HTTP code

401HTTP code

403HTTP code

404HTTP code

409HTTP code

429HTTP code

500HTTP code

Response Examples

Sample Response: HTTP 200 - Google Chrome

Chrome payload added

Copied!

  {
    "addon_payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64125",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "payload_id": "1170",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "browser_type": "1",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "MANAGE_CHROME_ADDONS"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 200 - Mozilla Firefox

Firefox payload added

Copied!

  {
    "addon_payloads": [
      {
        "payload_type": "64127",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "2",
            "name": "System theme — auto",
            "binary_id": "13",
            "id": "default-theme@mozilla.org"
          }
        ],
        "payload_id": "1171",
        "pinned_binaries_details": [],
        "browser_type": "2",
        "policies": {
          "disable_user_extensions": "1"
        },
        "restrict_addons": "1",
        "config_label": "MANAGE_FIREFOX_ADDONS"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 200 - Microsoft Edge

Edge payload added

Copied!

  {
    "addon_payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64907",
        "restrict_domains": "-1",
        "binaries_details": [],
        "payload_id": "1172",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [],
        "browser_type": "5",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "CHROMIUM_EDGE_ADDONS_PAYLOAD"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 200 - Ulaa

Ulaa payload added

Copied!

  {
    "addon_payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64459",
        "restrict_domains": "-1",
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "payload_id": "1173",
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "browser_type": "31",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "MANAGE_ULAA_ADDONS"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 200 - Other Chromium

Chromium payload added

Copied!

  {
    "addon_payloads": [
      {
        "restrict_permissions": "1",
        "payload_type": "64409",
        "restrict_domains": "-1",
        "payload_id": "1174",
        "browser_type": "1024",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "applicable_browsers": [],
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        },
        "config_label": "CHROMIUM_ADDONS_PAYLOAD"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 200 - Internet Explorer

IE payload added

Copied!

  {
    "addon_payloads": [
      {
        "payload_type": "64126",
        "restrict_domains": "-1",
        "binaries_details": [],
        "payload_id": "1175",
        "pinned_binaries_details": [],
        "browser_type": "3",
        "policies": {
          "turn_off_blocking_outdated_addon": "1",
          "enable_extension": "1",
          "restrict_activex": "0",
          "remove_run_this_time": "0"
        },
        "restrict_addons": "0",
        "config_label": "MANAGE_IE_ADDONS"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 401

Unauthorized

Copied!

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

▼ Show full

Sample Response: HTTP 403

Insufficient permissions

Copied!

  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }

▼ Show full

Sample Response: HTTP 404

Profile not found

Copied!

  {
    "errormsg": "Profile not found"
  }

▼ Show full

Sample Response: HTTP 409

Cannot modify published profile

Copied!

  {
    "errormsg": "Cannot modify published policy. Clone the policy and retry"
  }

▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!

  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "errormsg": "Internal Server error, Please try again in a moment."
  }

▼ 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.