Create a new add-on entry

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

Creates a new add-on in the inventory and returns its details.

Endpoints

Request URL

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

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Request Body

JSON body with addon identifier and browser type. For extensions, provide the webstore ID. For plugins, provide the CLSID/GUID

application/json
JSON Object
Hide Sub-Attributes
idstringOptional

Addon identifier. For extensions: the webstore ID. For plugins: the CLSID/GUID in curly braces

browser_typestringOptional

Browser type code. 1=Chrome, 2=Firefox, 3=Internet Explorer, 5=Chromium Edge, 31=Ulaa, 1024=Other Chromium

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/addons \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"browser_type":1,"id":"cjpalhdlnbpafiamejdnhcphjbkeiagm"}'

Sample Request Body

Chrome extension (browser_type=1)

Copied!
  {
    "browser_type": 1,
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
  }
                
Show full

Firefox extension (browser_type=2)

Copied!
  {
    "browser_type": 2,
    "id": "uBlock0@raymondhill.net"
  }
                
Show full

Chromium Edge extension (browser_type=5)

Copied!
  {
    "browser_type": 5,
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
  }
                
Show full

Ulaa extension (browser_type=31)

Copied!
  {
    "browser_type": 31,
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
  }
                
Show full

Other Chromium extension (browser_type=1024)

Copied!
  {
    "browser_type": 1024,
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
  }
                
Show full

IE plugin by CLSID (browser_type=3)

Copied!
  {
    "browser_type": 3,
    "id": "{CAFEEFAC-0018-0000-FFFF-ABCDEFFEDCBA}"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
extension_group_idstring

Unique identifier for the extension group

browser_typestring

Browser type code. 1=Chrome, 2=Firefox, 3=Internet Explorer, 5=Chromium Edge, 31=Ulaa, 1024=Other Chromium

binary_idstring

Unique binary ID used as the universal addon reference

idstring

Addon webstore identifier (e.g., Chrome extension ID)

customer_idstring

Customer identifier

binary_typestring

Type of the binary. Only present on first creation

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

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Created Chrome extension

Copied!
  {
    "extension_group_id": "100",
    "browser_type": "1",
    "binary_id": "100",
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
    "customer_id": "2",
    "binary_type": "7"
  }
                
Show full

Created Firefox extension

Copied!
  {
    "extension_group_id": "101",
    "browser_type": "2",
    "binary_id": "101",
    "id": "uBlock0@raymondhill.net",
    "customer_id": "2",
    "binary_type": "7"
  }
                
Show full

Created Chromium Edge extension

Copied!
  {
    "extension_group_id": "102",
    "browser_type": "5",
    "binary_id": "102",
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
    "customer_id": "2",
    "binary_type": "7"
  }
                
Show full

Created Ulaa extension

Copied!
  {
    "extension_group_id": "338",
    "browser_type": "31",
    "binary_id": "338",
    "id": "oeopbcgkkoapgobdbedcemjljbihmemj",
    "customer_id": "1",
    "binary_type": "7"
  }
                
Show full

Created Other Chromium extension

Copied!
  {
    "extension_group_id": "103",
    "browser_type": "1024",
    "binary_id": "103",
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm",
    "customer_id": "2",
    "binary_type": "7"
  }
                
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": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Rate limit exceeded

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

Server error

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.