Clone a published configuration profile

Clones a published configuration profile with all its payloads.

Endpoints

post /bsp/api/v1/bmp/profiles/{profile_id}/clone

Copy full URL

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/profiles/{profile_id}/clone

Scope

BrowserManager.CREATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory

application/jsonCopied!

- Path Parameters

profile_idstringMandatory

Retrieve the configuration profile ID from the profileid key in the response returned by List Configuration Profiles

Sample Request

Curl

Java

Python

Deluge

PowerShell

Copied!

curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/profiles/{profile_id}/clone \
  --header 'Accept: application/json' \
  --header 'Authorization:  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://appdomain/bsp/api/v1/bmp/profiles/{profile_id}/clone"))
        .header("Accept", "application/json")
        .header("Authorization", " 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("appdomain")

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

conn.request("POST", "/bsp/api/v1/bmp/profiles/{profile_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://appDomain/bsp/api/v1/bmp/profiles/{profile_id}/clone"
        type: POST
        headers: headersMap
        connection: connection_name
    ]

    info response;

$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/bsp/api/v1/bmp/profiles/{profile_id}/clone' -Method POST -Headers $headers

Response Parameters

- HTTP code 200

Response Body - application/json

JSON Object

Full configuration profile details including metadata, version info, and associated payloads

Hide Sub-Attributes

profile_idstring

Profile ID

profile_namestring

Display name

profile_descriptionstring

Description

profile_typestring

Profile type code. 64100=Browser Customization, 64005=File Activity, 64011=Browser Router, 64050=Web Isolation, 64200=Threat Prevention, 64201=Data Leakage Prevention, 64210=Browser Lockdown, 64500=Compliance, 64510=Default Extension, 64950=URL Filter, 64960=Managed Browser

scopestring

'0'=Device, '1'=User

is_moved_to_trashboolean

In trash

collection_idstring

Collection reference ID

platform_typestring

'1'=Windows, '2'=Mac, '-1'=All platforms (Windows + Mac)

latest_versionstring

Latest version (increments on modify)

latest_published_versionstring

Latest published version, or '--' if never published

payloadsJSON Array

Associated payload configurations

Show Sub-Attributes

JSON Object

Individual payload configuration item returned in profile responses

Show Sub-Attributes

config_namestring

Internal config name (config_label in Add/Modify responses)

payload_typestring

Payload type code. 64200=Threat, 64201=DLP, 64151=Web Isolation, 64210=Browser Lockdown, 64950=URL Filter, 64960=Managed Browser, 64025=Add-on, 64011=Browser Router, 64012=Java Rules, 64800=Content Restriction, 64801=Upload Restriction

payload_idstring

Payload instance ID

- HTTP code 401

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)

errorMsgstring

Authentication failure reason

- HTTP code 403

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)

errorMsgstring

Message indicating insufficient privileges to access this resource

- HTTP code 404

Response Body - application/json

JSON Object

Resource not found error

Hide Sub-Attributes

errormsgstring

Not found error message

- HTTP code 409

Response Body - application/json

JSON Object

Conflict error due to the current state of the profile

Hide Sub-Attributes

errormsgstring

Conflict error message

- HTTP code 429

Response Body - application/json

JSON Object

Hide Sub-Attributes

errorCodelong

Rate limit error code returned when the API call threshold (configured via threshold/duration in security XML) is exceeded; client is locked out for lock-period minutes

errorMsgstring

Rate limit exceeded message with retry guidance

- HTTP code 500

Response Body - application/json

JSON Object

Internal server error response for profile 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

409HTTP code

429HTTP code

500HTTP code

Sample Response: HTTP 200

Cloned File Activity Restriction profile (64005)

Copied!

  {
    "collection_id": "222",
    "profile_name": "FileActivityFilter 3",
    "profile_type": "64005",
    "platform_type": "-1",
    "latest_version": "2",
    "is_moved_to_trash": false,
    "payloads": [
      {
        "config_name": "CONTENT_RESTRICTION_PAYLOAD",
        "payload_type": "64800",
        "payload_id": "332",
        "custom_mail_id": "--",
        "custom_message": "--",
        "exclude_rules_json": {
          "sites": [],
          "site_groups": []
        },
        "all_condition_match": true,
        "rules_json": {
          "rule_01": {
            "rule_type": 2,
            "rule_value": [
              "5"
            ],
            "enable": "0",
            "range": 1,
            "greater": 0
          },
          "rule_execution_order": "(rule_01)"
        },
        "message_type": "0",
        "whitelisted": "0",
        "custom_logo_path": "--"
      }
    ],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "1",
    "profile_description": ""
  }

▼ Show full

Cloned URL Filter profile (64950)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Updated Policy Name",
    "profile_type": "64950",
    "platform_type": "-1",
    "latest_version": "3",
    "is_moved_to_trash": false,
    "payloads": [
      {
        "ssl_cert_protection": "-1",
        "config_name": "URL_FILTER_PAYLOAD",
        "payload_type": "64950",
        "payload_id": "928",
        "block_malicious_site": "-1",
        "rules_json": {
          "rule_2": {
            "enable": "1",
            "rule_value": [
              "00:00:00",
              "23:59:59"
            ],
            "range": "1",
            "type": "1",
            "greater": "0"
          },
          "rule_1": {
            "enable": "0",
            "rule_value": {
              "categories": [
                {
                  "name": "News",
                  "id": "1"
                }
              ]
            },
            "range": "1",
            "type": "2",
            "greater": "0"
          },
          "rule_execution_order": "(rule_1 & rule_2)"
        },
        "restrict_cert_override_error": "-1",
        "custom_mail_id": "--",
        "custom_message": "Access to this website [domain] [category] is currently blocked in your organization. Contact your system administrator for further information",
        "block_websites_with_ads": "-1",
        "whitelisted": "0",
        "webcategory_override_allowed": "0",
        "block_other_sites_to_injectcode": "-1",
        "custom_logo_path": "603",
        "custom_url": "--"
      }
    ],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "2",
    "profile_description": ""
  }

▼ Show full

Cloned Web Isolation profile (64050)

Copied!

  {
    "collection_id": "222",
    "profile_name": "Isolation Policy Copy",
    "profile_type": "64050",
    "platform_type": "1",
    "latest_version": "1",
    "is_moved_to_trash": false,
    "payloads": [
      {
        "payload_type": "64151",
        "payload_id": "532",
        "proxy_range": "10.0.0.0/8",
        "defender_app_gaurd_id": "200",
        "sites": [
          {
            "name": "www.google.com",
            "id": "304",
            "type": "webdomain"
          }
        ],
        "allow_session_persistence": "1",
        "prevent_non_ent_in_ent": "0",
        "config_label": "WEB_ISOLATION"
      }
    ],
    "profile_id": "111",
    "scope": "0",
    "latest_published_version": "--",
    "profile_description": "Cloned from Isolation Policy"
  }

▼ Show full

Sample Response: HTTP 401

API key is missing or invalid

Copied!

  {
    "errorCode": "IAM0001",
    "errorMsg": "Authentication key is invalid. Please regenerate the key and try again."
  }

▼ Show full

Sample Response: HTTP 403

Forbidden

Copied!

  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "User does not have permission to perform this operation"
  }

▼ Show full

Sample Response: HTTP 404

Source profile to clone does not exist

Copied!

  {
    "errormsg": "Profile not found"
  }

▼ Show full

Sample Response: HTTP 409

Only published profiles can be cloned

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!

  {
    "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.