Retrieve current agent settings

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

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

Request URL

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

Scope

DesktopCentralCloud.BrowserManager.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

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

Response Parameters

- HTTP code 200

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

Agent service protection settings controlling uninstall, modify, and stop service permissions

Show Sub-Attributes
disable_agent_uninstall_bspstring

Prevent agent uninstallation. '0'=uninstall allowed, '1'=prevented

disable_agent_modify_bspstring

Prevent agent modification. '0'=modification allowed, '1'=prevented

disable_agent_stop_service_bspstring

Prevent agent service stop. '0'=service stop allowed, '1'=prevented

extension_settingsJSON Object

Browser extension deployment settings for Chrome, Firefox, Edge, Chromium, Ulaa, and BHO

Show Sub-Attributes
chrome_extension_bspstring

Chrome extension deployment status. '0'=disabled, '1'=deployed

firefox_extension_bspstring

Firefox extension deployment status. '0'=disabled, '1'=deployed

edge_extension_bspstring

Edge extension deployment status. '0'=disabled, '1'=deployed

enable_bho_bspstring

Browser Helper Object status. '0'=disabled, '1'=enabled

chromium_extension_bspstring

Chromium extension deployment status. '0'=disabled, '1'=deployed

ulaa_extension_bspstring

Ulaa extension deployment status. '0'=disabled, '1'=deployed

comman_settingsJSON Object

Common tracking settings for web activity, intranet web tracking, and SQLite data collection

Show Sub-Attributes
enable_web_tracking_bspstring

Web activity tracking status. '0'=disabled, '1'=web tracking enabled

enable_intranet_web_tracking_bspstring

Intranet web activity tracking status. '0'=disabled, '1'=intranet tracking enabled

enable_sqlitestring

SQLite data collection status. This field is read-only and automatically managed by the system

- 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

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

Sample Response: HTTP 200

Agent settings

Copied!
  {
    "service_settings": {
      "disable_agent_modify_bsp": "1",
      "disable_agent_uninstall_bsp": "1",
      "disable_agent_stop_service_bsp": "1"
    },
    "comman_settings": {
      "enable_sqlite": "1",
      "enable_web_tracking_bsp": "1",
      "enable_intranet_web_tracking_bsp": "1"
    },
    "extension_settings": {
      "firefox_extension_bsp": "1",
      "chrome_extension_bsp": "1",
      "enable_bho_bsp": "1",
      "edge_extension_bsp": "1",
      "chromium_extension_bsp": "1",
      "ulaa_extension_bsp": "1"
    }
  }
                
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.