Get summary details of an add-on

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 the summary details of an add-on, including its name, identifier, and installation count.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

binary_idstringMandatory

Add-on binary ID from List Add-Ons or Import Add-Ons response (binary_id field)

Sample Request

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

Response Parameters

- HTTP code 200

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

Number of managed devices with this addon installed

namestring

Addon display name

idstring

Addon identifier webstore ID for extensions, CLSID for plugins

- HTTP code 400

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

Message indicating the addon type is not supported

- 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

Chrome extension summary

Copied!
  {
    "count": 25,
    "name": "uBlock Origin",
    "id": "cjpalhdlnbpafiamejdnhcphjbkeiagm"
  }
                
Show full

Plugin summary

Copied!
  {
    "count": 10,
    "name": "Java Plugin",
    "id": "{CAFEEFAC-0018-0000-FFFF-ABCDEFFEDCBA}"
  }
                
Show full

Addon with no installations

Copied!
  {
    "count": 0,
    "name": "Dark Reader",
    "id": "eimadpbcbfnmbkopoojfekhnkhdbieeh"
  }
                
Show full

Sample Response: HTTP 400

Unsupported addon type

Copied!
  {
    "error_description": "Binary Type not supported"
  }
                
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.