Retrieves the current agent settings for service protection, browser extension deployment, and web tracking.
get /bsp/api/v1/bmp/agent/settings
https://{serverurl}/bsp/api/v1/bmp/agent/settings
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomains/bsp/api/v1/bmp/agent/settings \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'Agent service protection settings controlling uninstall, modify, and stop service permissions
Prevent agent uninstallation. '0'=uninstall allowed, '1'=prevented
Prevent agent modification. '0'=modification allowed, '1'=prevented
Prevent agent service stop. '0'=service stop allowed, '1'=prevented
Browser extension deployment settings for Chrome, Firefox, Edge, Chromium, Ulaa, and BHO
Chrome extension deployment status. '0'=disabled, '1'=deployed
Firefox extension deployment status. '0'=disabled, '1'=deployed
Edge extension deployment status. '0'=disabled, '1'=deployed
Browser Helper Object status. '0'=disabled, '1'=enabled
Chromium extension deployment status. '0'=disabled, '1'=deployed
Ulaa extension deployment status. '0'=disabled, '1'=deployed
Common tracking settings for web activity, intranet web tracking, and SQLite data collection
Web activity tracking status. '0'=disabled, '1'=web tracking enabled
Intranet web activity tracking status. '0'=disabled, '1'=intranet tracking enabled
SQLite data collection status. This field is read-only and automatically managed by the system
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
Agent settings
{
"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"
}
}
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.