Retrieve a list of managed extensions

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

Fetches a list of managed extensions across your managed devices.

Endpoints

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Query Parameters

searchstringOptional

Search string to filter extensions by name (contains match). Example: 'adblock', 'grammarly'

browser_typestringOptional

Filter by browser type ID (comma-separated for multiple) from List Browsers response (browser_type field). Example: '1' (Chrome), '2' (Firefox), '5' (Edge)

limitintegerOptional

Max results per page. Example: 50, 100, 200

offsetintegerOptional

Starting index for results (0-based). Example: 0, 50, 100

skip-tokenstringOptional

Cursor-based pagination token returned from previous response for fetching next page

trashbooleanOptional

Include trashed extensions in results. Example: true, false

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

List of managed extensions

Hide Sub-Attributes
managed_extensionsJSON Array

Managed extension summaries

Show Sub-Attributes
JSON Object

Summary of a managed extension

Show Sub-Attributes
extension_idstring

Unique identifier of the extension profile

latest_versionstring

Latest version string

browser_typestring

Browser type. 1=Chrome, 2=Firefox, 5=Edge

extension_namestring

Display name of the extension

binary_idstring

Binary record identifier

idstring

Webstore or internal extension ID

- HTTP code 400

Response Body - application/json
JSON Object

Bad request error when limit parameter exceeds the allowed maximum range

Hide Sub-Attributes
errorCodestring

Error code indicating the limit exceeds the allowed range

errorMsgstring

Human-readable message

urlstring

The request URL path

- 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

Internal server error during extension operations

Hide Sub-Attributes
error_descriptionstring

Error message describing the server failure

error_codestring

Error code for internal server errors

Possible Response Codes

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

Sample Response: HTTP 200

Extensions list

Copied!
  {
    "managed_extensions": [
      {
        "extension_id": "606",
        "latest_version": "3.17.2",
        "browser_type": "1",
        "extension_name": "Selenium IDE",
        "binary_id": "602",
        "id": "mooikfkahbdckldjjndioackbalphokd"
      }
    ]
  }
                
Show full

Empty list

Copied!
  {
    "managed_extensions": []
  }
                
Show full

Sample Response: HTTP 400

Limit out of range

Copied!
  {
    "errorCode": "ARRAY_SIZE_OUT_OF_RANGE",
    "url": "/bsp/api/v1/bmp/extensions",
    "errorMsg": "The requested array size is out of the allowed range"
  }
                
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

Forbidden

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.