Retrieve detailed information about a specific extension

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 detailed information about a specific extension including permissions, metadata, install source, homepage URL, update URL, and extension type.

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

extension_idstringMandatory

Extension Profile ID from List Extensions response (extension_id field)

Sample Request

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object

Detailed extension information

Hide Sub-Attributes
installsourcestring

Numeric install source code

browser_typestring

Browser type as string

img_filestring

Extension icon/logo filename

descriptionstring

Extension description

extn_typestring

Extension source type

shortnamestring

Short identifier name

versionstring

Extension version string

extensionnamestring

Extension name

homepageurlstring

Extension homepage URL

crx_pathstring

Path to the CRX extension package

permissionsarray

All permission names

updateurlstring

Extension update check URL

idstring

Webstore or internal extension ID

extension_logo_idstring

Logo asset identifier

allowed_permissionsarray

Allowed permission names

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

Sample Response: HTTP 200

Extension details

Copied!
  {
    "installsource": "1",
    "browser_type": "9",
    "img_file": "NormalState-48.png",
    "description": "Now everyone on the team can own quality. Capture findings, create issues, and collaborate with the team, directly from the browser.",
    "extn_type": "web_store",
    "shortname": "XT, exploratory tesing, feedback, TF",
    "version": "1.0.271.1",
    "extensionname": "Test  Feedback",
    "homepageurl": "https://marketplace.visualstudio.com/items?itemName=ms.vss-exploratorytesting-web",
    "crx_path": "..\\webapps\\DesktopCentral\\bsp\\client-data\\1\\ManagedExtensions\\6",
    "permissions": [
      "Active tab",
      "Clipboard read",
      "Tabs",
      "Storage",
      "Desktop capture",
      "Unlimited storage",
      "CPU metadata",
      "Memory metadata",
      "Display metadata",
      "Web navigation",
      "Background",
      "Tab capture",
      "Alarms"
    ],
    "updateurl": "https://clients2.google.com/service/update2/crx",
    "id": "gnldpbnocfnlkkicnaplmkaphfdnlplb",
    "extension_logo_id": "606",
    "allowed_permissions": []
  }
                
Show full

Invalid extension ID

Copied!
  {}
                
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.