# Update agent settings configuration

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

## Endpoint

**POST** `/bsp/api/v1/bmp/agent/settings`

## Request Details

### Request URL

`https://{server-hostname}:8383/bsp/api/v1/bmp/agent/settings`

### Scope

`BrowserManager.CREATE`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Content-Type** `string` — **Mandatory**: `application/json`
- **Accept** `string` — **Mandatory**: `application/json`

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

- `service_settings` `JSON object` — Optional
  - Agent service protection settings to update
- `extension_settings` `JSON object` — Optional
  - Browser extension deployment settings to update
- `comman_settings` `JSON object` — Optional
  - Common tracking settings to update

### Sample Request

```curl
curl --request POST \
  --url https://appdomain/bsp/api/v1/bmp/agent/settings \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/json' \
  --data '{"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"}}'
```

### Sample Request Body

Update all agent Settings

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

## Response Parameters

### HTTP Code 204

Response Body — `application/json`

`JSON object`

### HTTP Code 401

Response Body — `application/json`

`JSON object`

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

### HTTP Code 403

Response Body — `application/json`

`JSON object`

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

### HTTP Code 429

Response Body — `application/json`

`JSON object`

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

### HTTP Code 500

Response Body — `application/json`

`JSON object`

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

### Possible Response Codes

- **204** `HTTP code` — Returns 204 No Content on success.
- **401** `HTTP code`
- **403** `HTTP code`
- **429** `HTTP code`
- **500** `HTTP code`

### Sample Response: HTTP 204

```text
204 Returns 204 No Content on success.
```

### Sample Response: HTTP 401

Authentication credentials are missing or invalid

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

### 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"
}
```

### 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."
}
```

### Sample Response: HTTP 500

An unexpected server error occurred

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

## API Rate Limit

![](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.