Retrieve full details of a managed extension profile

Retrieves the full details of a managed extension profile.

Endpoints

get /bsp/api/v1/bmp/extensions/{extension_id}

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/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} \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) {

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://appdomains/bsp/api/v1/bmp/extensions/{extension_id}"))
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("GET", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("appdomains")

headers = {
    'Accept': "application/json",
    'Authorization': "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("GET", "/bsp/api/v1/bmp/extensions/{extension_id}", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/extensions/{extension_id}"
        type: GET
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomains/bsp/api/v1/bmp/extensions/{extension_id}' -Method GET -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Extension profile details including payloads

Hide Sub-Attributes

extension_idstring

Unique identifier of the extension profile

collection_idstring

Collection reference ID

platform_typestring

Platform type. 1=Windows, 2=Mac, -1=All

latest_versionstring

Latest version number

is_moved_to_trashboolean

Whether the extension profile is in the trash

scopestring

Profile scope. 0=device scope

latest_published_versionstring

Latest published version number

extension_namestring

Display name of the extension

extension_descriptionstring

Description of the extension

extension_payloadsJSON Array

Extension payload configurations

Show Sub-Attributes

JSON Object

Individual extension payload configuration

Show Sub-Attributes

payload_typestring

Payload type identifier. 64120 for extensions

extension_payload_idstring

Unique identifier of the extension payload

extension_detailsJSON Object

Extension metadata

Show Sub-Attributes

installsourcestring

Numeric install source code. 1=webstore, 2=sideloaded, 3=inhouse

browser_typestring

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

img_filestring

Extension icon/logo filename

descriptionstring

Extension description

extn_typestring

Extension source type: web_store or inhouse

shortnamestring

Short identifier name

versionstring

Extension version string

extensionnamestring

Extension name from the manifest

homepageurlstring

Extension homepage URL

crx_pathstring

Path to the CRX/XPI extension package

permissionsarray

Permission names

updateurlstring

Extension update check URL

idstring

Webstore or internal extension ID

extension_logo_idstring

Logo asset identifier

allowed_permissionsarray

Allowed permission names

binary_idstring

Binary record identifier

- HTTP code 400

Response Body - application/json

JSON Object

Invalid request error when the specified extension profile ID does not exist

Hide Sub-Attributes

errorcodestring

Error code for invalid requests

errormsgstring

Human-readable message indicating the request is invalid

- 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

Extension profile

Copied!

  {
    "extension_id": "608",
    "collection_id": "222",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "scope": "0",
    "latest_published_version": "1",
    "extension_name": "Test  Feedback",
    "extension_description": "Now everyone on the team can own quality. Capture findings, create issues, and collaborate with the team, directly from the browser.",
    "extension_payloads": [
      {
        "payload_type": "64120",
        "extension_payload_id": "924",
        "extension_details": {
          "installsource": "1",
          "browser_type": "1",
          "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": "604",
          "allowed_permissions": []
        },
        "binary_id": "604"
      }
    ]
  }

▼ Show full

Sample Response: HTTP 400

Invalid extension ID

Copied!

  {
    "errorcode": "IAM0003",
    "errormsg": "Invalid request."
  }

▼ 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.