Updates the agent settings for service protection, browser extension deployment, and web tracking.
post /bsp/api/v1/bmp/agent/settings
https://{serverurl}/bsp/api/v1/bmp/agent/settings
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
JSON body with agent settings grouped into service_settings, extension_settings, and comman_settings. All values are string booleans (0 or 1)
Agent service protection settings to update
Prevent agent uninstallation. '0'=allow, '1'=prevent
Prevent agent modification. '0'=allow, '1'=prevent
Prevent agent service stop. '0'=allow, '1'=prevent
Browser extension deployment settings to update
Enable Chrome extension deployment. '0'=disable, '1'=deploy
Enable Firefox extension deployment. '0'=disable, '1'=deploy
Enable Edge extension deployment. '0'=disable, '1'=deploy
Enable Browser Helper Object. '0'=disable, '1'=enable
Enable Chromium extension deployment. '0'=disable, '1'=deploy
Enable Ulaa extension deployment. '0'=disable, '1'=deploy
Common tracking settings to update
Enable web activity tracking. '0'=disable, '1'=enable
Enable intranet web activity tracking. '0'=disable, '1'=enable
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 '{}'Update all agent Settings
{
"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"
}
}
Unauthorized error code: credentials missing, expired, or invalid
Authentication failure reason
Error code indicating insufficient permissions
Message indicating insufficient privileges to access this resource
Rate limit error code returned when the API call reached threshold
Rate limit exceeded message with retry guidance
Message describing the internal server error
Error code identifying the type of server error
Returns 204 No Content on success.
204 Returns 204 No Content on success.Authentication credentials are missing or invalid
{
"errorCode": "UNAUTHORIZED",
"errorMsg": "You are not authorized to perform this action"
}
The user does not have the required permissions to perform this action
{
"errorCode": "FORBIDDEN",
"errorMsg": "You do not have permission to access this resource"
}
Too many API requests have been made
{
"errorCode": "RATE_LIMIT_EXCEEDED",
"errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
An unexpected server error occurred
{
"error_description": "Internal Server error, Please try again in a moment.",
"error_code": "COM0004"
}
![]()
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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.