Modify an existing add-on management profile

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

Modifies an add-on management profile's name and description. Use Modify Payload to change browser-specific rules.

Request URL

https://{server-hostname}:8383/bsp/api/v1/bmp/manage_addons/{addon_id}

Scope

BrowserManager.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

Content-TypestringMandatory
application/jsonapplication/jsonCopied!
AcceptstringMandatory
application/jsonapplication/jsonCopied!

- Path Parameters

addon_idstringMandatory

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

- Request Body

JSON body with updated profile name and/or description

application/json
JSON Object
Hide Sub-Attributes
manage_addOn_namestringOptional

Updated profile name (max 500 characters)

manage_addon_descriptionstringOptional

Updated profile description (max 500 characters)

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/bsp/api/v1/bmp/manage_addons/{addon_id} \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"manage_addon_description":"Updated description","manage_addOn_name":"Updated Addon Name"}'

Sample Request Body

Update profile name and description

Copied!
  {
    "manage_addon_description": "Updated description",
    "manage_addOn_name": "Updated Addon Name"
  }
                
Show full

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
profile_collection_statusstring

Profile status. 110=Published, 1=Draft

collection_idstring

Collection reference ID

profile_namestring

Updated profile name

profile_typestring

Profile type identifier

profile_idstring

Unique profile identifier

configuredstatusJSON Object

Indicates which browser add-on policies are configured

Show Sub-Attributes
manage_chrome_addons_countstring

Present with value 'true' when a Chrome payload is configured

manage_firefox_addons_countstring

Present with value 'true' when a Firefox payload is configured

manage_ie_addons_countstring

Present with value 'true' when an IE payload is configured

chromium_addons_payload_countstring

Present with value 'true' when a Chromium payload is configured

manage_ulaa_addons_countstring

Present with value 'true' when a Ulaa payload is configured

chromium_edge_addons_payload_countstring

Present with value 'true' when an Edge payload is configured

last_modified_bystring

User ID who performed the modification

profile_descriptionstring

Updated profile description

- 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
Hide Sub-Attributes
errormsgstring

Message indicating the requested resource was not found

- 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
Hide Sub-Attributes
errormsgstring

Message describing the internal server error

Possible Response Codes

200HTTP code
401HTTP code
403HTTP code
404HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 200

Profile metadata updated

Copied!
  {
    "profile_collection_status": "1",
    "collection_id": "222",
    "profile_name": "TestAddon_Renamed",
    "profile_type": "64025",
    "profile_id": "111",
    "configuredstatus": {
      "manage_firefox_addons_count": "true",
      "manage_chrome_addons_count": "true"
    },
    "last_modified_by": "1",
    "profile_description": "Updated description"
  }
                
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 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.