List browser add-ons

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

Retrieves all registered add-ons, including extensions and plugins.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

typestringOptional

Optional. Filter by add-on type: 'plugins' or 'extensions'

namestringOptional

Optional. Search add-ons by name (case-insensitive partial match). Example: ?name=uBlock

browser_typestringOptional

Optional. Filter by browser type ID (1=Chrome, 2=Firefox, 3=IE, 5=Edge, 31=Ulaa, 1024=Other Chromium). Accepts comma-separated values for multiple browsers

limitintegerOptional

Optional. Maximum number of add-ons to return per page. Used for pagination

offsetintegerOptional

Optional. Number of add-ons to skip before starting to return results. Used for pagination

skip-tokenstringOptional

Optional. Token for pagination to retrieve the next set of results

idstringOptional

Optional. Search by add-on identifier (extension ID or plugin CLSID/GUID)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/bsp/api/v1/bmp/addons \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Pagination metadata containing navigation URLs for next and previous pages

Show Sub-Attributes
nextstring

URL for the next page of results. Null if no more pages

previousstring

URL for the previous page of results. Null if on the first page

addonsJSON Array

Addon records (extensions and/or plugins) for the current page

Show Sub-Attributes
JSON Object
Show Sub-Attributes
browser_typestring

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

namestring

Addon display name

binary_idstring

Unique binary ID used as the universal addon reference

idstring

Addon identifier webstore ID for extensions, CLSID for plugins

typelong

Plugin type code. Present only for plugin entries. 100=Plugin Group, 101=Plugin Version Group

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

Sample Response: HTTP 200

Paginated extension list

Copied!
  {
    "addons": [
      {
        "browser_type": "1",
        "name": "uBlock Origin",
        "binary_id": "100",
        "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
      },
      {
        "browser_type": "5",
        "name": "MoveTab",
        "binary_id": "48",
        "id": "ebldafnijcbblaaabcehdamipojmicmg"
      },
      {
        "browser_type": "1024",
        "name": "Dark Reader",
        "binary_id": "103",
        "id": "eimadpbcbfnmbkopoojfekhnkhdbieeh"
      }
    ],
    "paging": {
      "next": "<server-url>/bsp/api/v1/bmp/addons?skip-token=NTA6LTQ4OjI6MTc3NTQ1NTc5NjY5Ng%3D%3D"
    }
  }
                
Show full

Paginated plugin list

Copied!
  {
    "addons": [
      {
        "name": "Java Plugin",
        "binary_id": "104",
        "id": "{CAFEEFAC-0018-0000-FFFF-ABCDEFFEDCBA}",
        "type": 100
      }
    ]
  }
                
Show full

Empty result

Copied!
  {
    "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": "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: 120 | 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.