Bulk import add-ons from a CSV file

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

Bulk imports add-ons from a CSV file. Limited to 5000 entries and 30 MB.

Request URL

https://{serverurl}/bsp/api/v1/bmp/addons/import

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

JSON body with CSV file ID and browser type. The CSV file must contain an Identifier column header with addon IDs. Maximum 5000 entries, file size limit 30MB

application/json
JSON Object
Hide Sub-Attributes
file_idlongOptional

File ID of the previously uploaded CSV file containing addon identifiers

browser_typestringOptional

Browser type for all imported add-ons. 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://appdomains/bsp/api/v1/bmp/addons/import \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Import Chrome extensions (browser_type=1)

Copied!
  {
    "file_id": 103,
    "browser_type": 1
  }
                
Show full

Import Edge extensions (browser_type=5)

Copied!
  {
    "file_id": 105,
    "browser_type": 5
  }
                
Show full

Import Other Chromium extensions (browser_type=1024)

Copied!
  {
    "file_id": 106,
    "browser_type": 1024
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
addonsJSON Array

Imported addon records with assigned binary IDs

Show Sub-Attributes
JSON Object
Show Sub-Attributes
idstring

Addon identifier from the CSV file

extension_group_idstring

Extension group ID. Present for extension type addons. Returned as string

binary_idstring

Binary ID assigned to the imported addon. Returned as string

- HTTP code 400

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

Error code indicating a request parameter has an invalid format

urlstring

The request URL that triggered the error

errorMsgstring

Message identifying which parameter has an invalid format

- HTTP code 401

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

Unauthorized error code: credentials missing, expired, or invalid

errorMsgstring

Authentication failure reason

- HTTP code 403

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

Error code indicating insufficient permissions

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 reached threshold

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
400HTTP code
401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Imported extensions with binary IDs

Copied!
  {
    "addons": [
      {
        "extension_group_id": "100",
        "binary_id": "100",
        "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
      },
      {
        "extension_group_id": "101",
        "binary_id": "101",
        "id": "gighmmpiobklfepjocnamgkkbiglidom"
      }
    ]
  }
                
Show full

Sample Response: HTTP 400

Invalid browser_type value

Copied!
  {
    "errorCode": "IAM0025",
    "url": "/bsp/api/v1/bmp/addons/import",
    "errorMsg": "browser_type is an invalid parameter format."
  }
                
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

File not found

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.