Clone a published add-on management profile

Clones a published add-on management profile into a new draft version, preserving all browser-specific payload configurations. Only published profiles can be cloned.

Endpoints

post /bsp/api/v1/bmp/manage_addons/{addon_id}/clone

Copy full URL

Request URL

https://{serverurl}/bsp/api/v1/bmp/manage_addons/{addon_id}/clone

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

addon_idstringMandatory

Add-On Management Profile ID from List Add-On Management Profiles response (manage_addon_id field)

- Query Parameters

new_profilebooleanOptional

Optional. true=clone as new profile; false/omitted=clone as new draft version. Default: false

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/manage_addons/{addon_id}/clone \
  --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/manage_addons/{addon_id}/clone"))
        .header("Accept", "application/json")
        .header("Authorization", "Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52")
        .method("POST", 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("POST", "/bsp/api/v1/bmp/manage_addons/{addon_id}/clone", 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/manage_addons/{addon_id}/clone"
        type: POST
        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/manage_addons/{addon_id}/clone' -Method POST -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Hide Sub-Attributes

collection_idstring

Collection reference ID for the profile

profile_typestring

Profile type identifier

platform_typestring

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

latest_versionstring

Latest version number of the profile

is_moved_to_trashboolean

Whether the profile is in the trash

manage_addon_namestring

Profile display name

scopestring

Profile scope. 0=device, 1=user

latest_published_versionstring

Latest published version, or '--' if not yet published

manage_addon_descriptionstring

Profile description

manage_addon_idstring

Unique profile identifier

addon_payloadsJSON Array

Payload configurations associated with this profile

Show Sub-Attributes

JSON Object

Show Sub-Attributes

restrict_permissionsstring

Permission restriction mode. 1=restrict, -1=not restricted. Not present for Firefox payloads

config_namestring

Internal configuration label for the payload type (e.g., MANAGE_CHROME_ADDONS). Returned by Create, Clone, and Get Profile endpoints

config_labelstring

Internal configuration label for the payload type (e.g., MANAGE_CHROME_ADDONS). Returned by Add Payload and Modify Payload endpoints instead of config_name

payload_typestring

Payload type ID. 64125=Chrome, 64127=Firefox, 64907=Edge, 64459=Ulaa, 64409=Chromium, 64126=IE

restrict_domainsstring

Domain restriction mode. 1=restrict, -1=not restricted

binaries_detailsJSON Array

Restricted/allowed add-on binaries

Show Sub-Attributes

JSON Object

Show Sub-Attributes

browser_typestring

Browser type code

namestring

Add-on display name

binary_idstring

Unique binary identifier

idstring

Extension/add-on identifier (webstore ID, Mozilla ID, or CLSID)

typestring

IE add-on type category. Present only for IE binaries

payload_idstring

Unique payload identifier

pinned_binaries_detailsJSON Array

Force-installed extension binaries

Show Sub-Attributes

JSON Object

Show Sub-Attributes

browser_typestring

Browser type code

namestring

Add-on display name

binary_idstring

Unique binary identifier

idstring

Extension/add-on identifier (webstore ID, Mozilla ID, or CLSID)

typestring

IE add-on type category. Present only for IE binaries

browser_typestring

Browser type. 1=Chrome, 2=Firefox, 3=IE, 5=Edge, 31=Ulaa, 1024=Chromium

policiesJSON Object

Browser-specific add-on policy settings

Show Sub-Attributes

disable_user_extensionsstring

Disable user-installed extensions. 1=disabled, -1=not set

allow_flashstring

Allow Flash. 1=allowed, -1=not set

turn_off_blocking_outdated_addonstring

IE: Disable blocking of outdated add-ons. 1=off, 0=on

enable_extensionstring

IE: Enable browser extensions. 1=enabled, 0=disabled

restrict_activexstring

IE: Restrict ActiveX controls. 1=restricted, 0=not restricted

remove_run_this_timestring

IE: Remove 'Run this time' button. 1=remove, 0=keep

restrict_addonsstring

Add-on restriction mode. 1=restrict, -1=not restricted

permissionsJSON Array

Restricted permissions list. Only present when restrict_permissions is enabled and permission IDs are configured

Show Sub-Attributes

JSON Object

Show Sub-Attributes

namestring

Permission display name

idstring

Permission identifier

applicable_browsersarray

Applicable browser identifiers. Present only for Chromium (browser_type=1024) payloads

native_hostsJSON Object

Native messaging host configuration. Not present for Firefox payloads

Show Sub-Attributes

native_permissionstring

Native host permission mode. 1=restrict, -1=not restricted

native_detailsarray

Native messaging host details

- 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

errormsgstring

Message indicating the requested resource was not found

- HTTP code 409

Response Body - application/json

JSON Object

Hide Sub-Attributes

errormsgstring

Message indicating why the clone operation cannot be performed

- 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

errormsgstring

Message describing the internal server error

Possible Response Codes

200HTTP code

401HTTP code

403HTTP code

404HTTP code

409HTTP code

429HTTP code

500HTTP code

Sample Response: HTTP 200

Cloned as new draft version

Copied!

  {
    "collection_id": "222",
    "profile_type": "64025",
    "platform_type": "1",
    "latest_version": "2",
    "is_moved_to_trash": false,
    "manage_addon_name": "FullTest_Renamed",
    "scope": "0",
    "latest_published_version": "1",
    "manage_addon_description": "Renamed description",
    "manage_addon_id": "996",
    "addon_payloads": [
      {
        "restrict_permissions": "1",
        "config_name": "MANAGE_CHROME_ADDONS",
        "payload_type": "64125",
        "restrict_domains": "-1",
        "payload_id": "1166",
        "binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "permissions": [
          {
            "name": "Context menu",
            "id": "10"
          }
        ],
        "pinned_binaries_details": [
          {
            "browser_type": "1",
            "name": "Google Translate",
            "binary_id": "30",
            "id": "aapbdbdomjkkjkaonfhkkikfgjllcleb"
          }
        ],
        "browser_type": "1",
        "policies": {
          "disable_user_extensions": "1",
          "allow_flash": "-1"
        },
        "restrict_addons": "1",
        "native_hosts": {
          "native_permission": "-1",
          "native_details": []
        }
      }
    ]
  }

▼ 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": "User does not have permission to perform this operation"
  }

▼ Show full

Sample Response: HTTP 404

Profile not found

Copied!

  {
    "errormsg": "Profile not found"
  }

▼ Show full

Sample Response: HTTP 409

Profile must be published to clone

Copied!

  {
    "errormsg": "Cannot clone unpublished profile."
  }

▼ Show full

Sample Response: HTTP 429

Rate limit exceeded

Copied!

  {
    "errorCode": "RATE_LIMIT_EXCEEDED",
    "errorMsg": "Too many requests. Please try again after 5 minutes"
  }

▼ Show full

Sample Response: HTTP 500

Server error

Copied!

  {
    "errormsg": "Internal Server error, Please try again in a moment."
  }

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