Upload and register a new managed extension

Uploads and registers a new managed extension (Chrome, Firefox, or Edge) and creates a distribution profile.

Endpoints

post /bsp/api/v1/bmp/extensions

Copy full URL

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

Content-TypestringMandatory

application/jsonCopied!

- Request Body

application/json

JSON Object

Request body for uploading and registering a new managed extension

Hide Sub-Attributes

app_idstringOptional

Webstore application identifier or Firefox add-on slug

typestringOptional

Extension source type: web_store, Non-webstore, or inhouse

browser_typestringOptional

Values 1=Chrome, 2=Firefox, 3=IE, 5=Edge, 31=Ulaa, 1024=Chromium

xpi_urlstringOptional

URL to Firefox XPI package

file_idintegerOptional

File identifier for inhouse extension packages

platform_typestringOptional

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

allowed_permissionsarrayOptional

List of permission names to allow

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/extensions \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

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"))
        .header("Content-Type", "application/json")
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.ofString("{}"))
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

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

payload = "{}"

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

conn.request("POST", "/bsp/api/v1/bmp/extensions", payload, headers)

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

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


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

    data=Map();

    response = invokeUrl
    [
        url: "https://appDomains/bsp/api/v1/bmp/extensions"
        type: POST
        headers: headersMap
        body: data
        connection: connection_name
    ]

    info response;

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

Sample Request Body

Chrome extension

Copied!

  {
    "platform_type": 1,
    "browser_type": 1,
    "type": "web_store",
    "app_id": "mooikfkahbdckldjjndioackbalphokd"
  }

▼ Show full

Firefox extension

Copied!

  {
    "platform_type": -1,
    "browser_type": 2,
    "type": "web_store",
    "app_id": "ublock-origin"
  }

▼ Show full

Edge extension

Copied!

  {
    "platform_type": 1,
    "browser_type": 5,
    "type": "web_store",
    "app_id": "jbkfoedolllekgbhcbcoahefnbanhhlh"
  }

▼ Show full

In-house (custom packaged) extension uploaded via file

Copied!

  {
    "platform_type": 1,
    "file_id": 78901,
    "browser_type": 1,
    "type": "inhouse",
    "allowed_permissions": [
      "tabs",
      "storage"
    ]
  }

▼ Show full

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 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 404

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorcodestring

Error code for invalid extension identifiers

errormsgstring

Human-readable message prompting the user to enter a valid extension identifier

- 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

404HTTP code

429HTTP code

500HTTP code

Sample Response: HTTP 200

Extension added

Copied!

  {
    "extension_id": "606",
    "collection_id": "222",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "scope": "0",
    "latest_published_version": "--",
    "extension_name": "Selenium IDE",
    "extension_description": "Selenium Record and Playback tool for ease of getting acquainted with Selenium WebDriver.",
    "extension_payloads": [
      {
        "payload_type": "64120",
        "extension_payload_id": "922",
        "extension_details": {
          "installsource": "1",
          "browser_type": "1",
          "img_file": "icon16.png",
          "description": "Selenium Record and Playback tool for ease of getting acquainted with Selenium WebDriver.",
          "extn_type": "web_store",
          "shortname": "Selenium IDE",
          "version": "3.17.2",
          "extensionname": "Selenium IDE",
          "homepageurl": "https://github.com/SeleniumHQ/selenium-ide",
          "crx_path": "..\\webapps\\DesktopCentral\\bsp\\client-data\\1\\ManagedExtensions\\2",
          "permissions": [
            "Tabs",
            "Active tab",
            "Context menu",
            "Downloads",
            "Web navigation",
            "Storage",
            "Debugger"
          ],
          "updateurl": "https://clients2.google.com/service/update2/crx",
          "id": "mooikfkahbdckldjjndioackbalphokd",
          "extension_logo_id": "602",
          "allowed_permissions": []
        },
        "binary_id": "602"
      }
    ]
  }

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

Invalid extension ID

Copied!

  {
    "errorcode": "BSP_EXT0001",
    "errormsg": "Enter a valid extension identifier"
  }

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