Update agent settings configuration

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

Updates the agent settings for service protection, browser extension deployment, and web tracking.

Request URL

https://{serverurl}/bsp/api/v1/bmp/agent/settings

Scope

DesktopCentralCloud.BrowserManager.CREATECopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

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

- Request Body

JSON body with agent settings grouped into service_settings, extension_settings, and comman_settings. All values are string booleans (0 or 1)

application/json
JSON Object
Hide Sub-Attributes
service_settingsJSON ObjectOptional

Agent service protection settings to update

Show Sub-Attributes
disable_agent_uninstall_bspstringOptional

Prevent agent uninstallation. '0'=allow, '1'=prevent

disable_agent_modify_bspstringOptional

Prevent agent modification. '0'=allow, '1'=prevent

disable_agent_stop_service_bspstringOptional

Prevent agent service stop. '0'=allow, '1'=prevent

extension_settingsJSON ObjectOptional

Browser extension deployment settings to update

Show Sub-Attributes
chrome_extension_bspstringOptional

Enable Chrome extension deployment. '0'=disable, '1'=deploy

firefox_extension_bspstringOptional

Enable Firefox extension deployment. '0'=disable, '1'=deploy

edge_extension_bspstringOptional

Enable Edge extension deployment. '0'=disable, '1'=deploy

enable_bho_bspstringOptional

Enable Browser Helper Object. '0'=disable, '1'=enable

chromium_extension_bspstringOptional

Enable Chromium extension deployment. '0'=disable, '1'=deploy

ulaa_extension_bspstringOptional

Enable Ulaa extension deployment. '0'=disable, '1'=deploy

comman_settingsJSON ObjectOptional

Common tracking settings to update

Show Sub-Attributes
enable_web_tracking_bspstringOptional

Enable web activity tracking. '0'=disable, '1'=enable

enable_intranet_web_tracking_bspstringOptional

Enable intranet web activity tracking. '0'=disable, '1'=enable

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request POST \
  --url https://appdomains/bsp/api/v1/bmp/agent/settings \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{}'

Sample Request Body

Update all agent Settings

Copied!
  {
    "service_settings": {
      "disable_agent_modify_bsp": "1",
      "disable_agent_uninstall_bsp": "1",
      "disable_agent_stop_service_bsp": "0"
    },
    "comman_settings": {
      "enable_web_tracking_bsp": "1",
      "enable_intranet_web_tracking_bsp": "0"
    },
    "extension_settings": {
      "firefox_extension_bsp": "1",
      "chrome_extension_bsp": "1",
      "enable_bho_bsp": "0",
      "edge_extension_bsp": "1",
      "chromium_extension_bsp": "1",
      "ulaa_extension_bsp": "1"
    }
  }
                
Show full

Response Parameters

- HTTP code 204

Response Body - application/json

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

Message describing the internal server error

error_codestring

Error code identifying the type of server error

Possible Response Codes

204HTTP code

Returns 204 No Content on success.

401HTTP code
403HTTP code
429HTTP code
500HTTP code

Sample Response: HTTP 204

Copied!
204 Returns 204 No Content on success.
Show full

Sample Response: HTTP 401

Authentication credentials are missing or invalid

Copied!
  {
    "errorCode": "UNAUTHORIZED",
    "errorMsg": "You are not authorized to perform this action"
  }
                
Show full

Sample Response: HTTP 403

The user does not have the required permissions to perform this action

Copied!
  {
    "errorCode": "FORBIDDEN",
    "errorMsg": "You do not have permission to access this resource"
  }
                
Show full

Sample Response: HTTP 429

Too many API requests have been made

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

An unexpected server error occurred

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.