# Updates the global remote control configuration settings

Saves the remote control configuration settings including viewer type, gateway SSL/non-SSL ports, WebSocket ports, connection policies, idle session timeout, screen blanking, and performance options. Accepts a JSON body with the full settings model.

## Endpoints

`PUT /dcapi/tools/remoteControl/rdsSettings`

## Request URL

`https://{server-hostname}:8383/dcapi/tools/remoteControl/rdsSettings`

## Scope

`RemoteControl.UPDATE`

## Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

- **Accept** — `string` — **Mandatory**
  - `application/remoteSettingsStatus.v1+json`
- **Content-Type** — `string` — **Mandatory**
  - `application/remoteSettingsInfo.v1+json`

### Request Body

`application/json`

`JSON Object`

- **gatewaySSLPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **gatewayNonSSLPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **wanCompressionType** — `string` — Optional
- **nsPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **serverPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **sslServerPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **ftSSLPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **ftNonSSLPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **lanCompressionType** — `string` — Optional
- **wsSSLPort** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **nioPort** — `string` — Optional
- **useSSL** — `string` — Optional
- **isTomcatGatewayEnabled** — `boolean` — Optional
- **endUserDisconnect** — `string` — Optional
- **isMousePointer** — `string` — Optional
- **showQuickLaunch** — `string` — Optional
- **isCaptureAlphaBlending** — `string` — Optional
- **isDisableAeroTheme** — `string` — Optional
- **isDisableWallpaper** — `string` — Optional
- **isPermanentPrompt** — `string` — Optional
- **viewerType** — `string` — Optional
- **isShowBlankScreen** — `string` — Optional
- **isViewOnlyMode** — `string` — Optional
- **timeoutAction** — `string` — Optional
- **wsNonSSLPort** — `string` — Optional
- **isLockKeyboardMouse** — `string` — Optional
- **showAgentWindow** — `string` — Optional
- **isReasonBoxEnabled** — `string` — Optional
- **isDisableWallpapaer** — `string` — Optional
- **isPromptEnabled** — `string` — Optional
- **idleTimeout** — `integer` — Optional
- **isIdleSessionTimeout** — `string` — Optional
- **isMultiConnEnabled** — `boolean` — Optional
- **compressionType** — `string` — Optional
- **colorQuality** — `string` — Optional
- **branchOfficeID** — `string` — Optional
  - RoleId. [Get Role Id](https://www.manageengine.com/products/desktop-central/help/api/onpremise/remotecontrol-save-rds-settings.html?getRoles)
- **branchOfficeName** — `string` — Optional

## Sample Request

### Curl

```curl
curl --request PUT \
  --url https://appdomain/dcapi/tools/remoteControl/rdsSettings \
  --header 'Accept: application/remoteSettingsStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/remoteSettingsInfo.v1+json' \
  --data '{"gatewayNonSSLPort":80,"wsSSLPort":8383,"viewerType":"HTML5","wsNonSSLPort":8020,"endUserDisconnect":1,"idleTimeout":30,"isIdleSessionTimeout":1,"isTomcatGatewayEnabled":true,"isMultiConnEnabled":true,"gatewaySSLPort":443,"useSSL":1}'
```

### Sample Request Body

```json
{
  "gatewayNonSSLPort": 80,
  "wsSSLPort": 8383,
  "viewerType": "HTML5",
  "wsNonSSLPort": 8020,
  "endUserDisconnect": 1,
  "idleTimeout": 30,
  "isIdleSessionTimeout": 1,
  "isTomcatGatewayEnabled": true,
  "isMultiConnEnabled": true,
  "gatewaySSLPort": 443,
  "useSSL": 1
}
```

## Response Parameters

### HTTP Code 200

#### Response Body

`application/json`

`JSON Object`

- **status** — `string`
  - Result of the operation: success or failure

## Possible Response Codes

- **200** — HTTP code

## Sample Response: HTTP 200

```json
{
  "status": "success"
}
```

## API Rate Limit

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

**Duration:** 1 minute | **Threshold:** 30 | **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.