# Retrieve current agent settings

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

## Endpoint

`GET /bsp/api/v1/bmp/agent/settings`

## Request URL

`https://[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)/bsp/api/v1/bmp/agent/settings`

### Scope

`DesktopCentralCloud.BrowserManager.READ`

### Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** (`string`, Mandatory): `application/json`

### Sample Request

```curl
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`

- `service_settings` (`JSON Object`): Agent service protection settings controlling uninstall, modify, and stop service permissions
- `extension_settings` (`JSON Object`): Browser extension deployment settings for Chrome, Firefox, Edge, Chromium, Ulaa, and BHO
- `comman_settings` (`JSON Object`): Common tracking settings for web activity, intranet web tracking, and SQLite data collection

### Sample Response: HTTP 200

Agent settings

```json
{
  "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"
  }
}
```

### HTTP code 401

Response Body — `application/json`

- `errorCode` (`long`): Unauthorized error code returned when authentication credentials are missing, expired, or invalid (authentication=required)
- `errorMsg` (`string`): Authentication failure reason

### Sample Response: HTTP 401

Authentication credentials are missing or invalid

```json
{
  "errorCode": "UNAUTHORIZED",
  "errorMsg": "You are not authorized to perform this action"
}
```

### HTTP code 403

Response Body — `application/json`

- `errorCode` (`long`): Forbidden error code returned when the authenticated user does not have the required uem-roles (e.g., DataEncryption_Admin or DataEncryptionRecoveryKey_Admin)
- `errorMsg` (`string`): Message indicating insufficient privileges to access this resource

### Sample Response: HTTP 403

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

```json
{
  "errorCode": "FORBIDDEN",
  "errorMsg": "You do not have permission to access this resource"
}
```

### HTTP code 429

Response Body — `application/json`

- `errorCode` (`long`): 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
- `errorMsg` (`string`): Rate limit exceeded message with retry guidance

### Sample Response: HTTP 429

Too many API requests have been made

```json
{
  "errorCode": "RATE_LIMIT_EXCEEDED",
  "errorMsg": "You have exceeded the maximum number of API calls. Please try again later."
}
```

### HTTP code 500

Response Body — `application/json`

- `error_description` (`string`): Message describing the internal server error
- `error_code` (`string`): Error code identifying the type of server error

### Sample Response: HTTP 500

An unexpected server error occurred

```json
{
  "error_description": "Internal Server error, Please try again in a moment.",
  "error_code": "COM0004"
}
```

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

**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.