Updates the global remote control configuration settings

Open in ChatGPT Open in ChatGPT to ask questions about this page
Open in Claude Open in Claude to ask questions about this page
Copy as MarkdownCopy this page as markdown to use with AI assistants
View as Markdown Open this page as markdown in a new tab

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.

Request URL

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

Scope

RemoteControl.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/remoteSettingsStatus.v1+jsonapplication/remoteSettingsStatus.v1+jsonCopied!
Content-TypestringMandatory
application/remoteSettingsInfo.v1+jsonapplication/remoteSettingsInfo.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
gatewaySSLPortstringOptional

RoleId. Get Role Id

gatewayNonSSLPortstringOptional

RoleId. Get Role Id

wanCompressionTypestringOptional
nsPortstringOptional

RoleId. Get Role Id

serverPortstringOptional

RoleId. Get Role Id

sslServerPortstringOptional

RoleId. Get Role Id

ftSSLPortstringOptional

RoleId. Get Role Id

ftNonSSLPortstringOptional

RoleId. Get Role Id

lanCompressionTypestringOptional
wsSSLPortstringOptional

RoleId. Get Role Id

nioPortstringOptional
useSSLstringOptional
isTomcatGatewayEnabledbooleanOptional
endUserDisconnectstringOptional
isMousePointerstringOptional
showQuickLaunchstringOptional
isCaptureAlphaBlendingstringOptional
isDisableAeroThemestringOptional
isDisableWallpaperstringOptional
isPermanentPromptstringOptional
viewerTypestringOptional
isShowBlankScreenstringOptional
isViewOnlyModestringOptional
timeoutActionstringOptional
wsNonSSLPortstringOptional
isLockKeyboardMousestringOptional
showAgentWindowstringOptional
isReasonBoxEnabledstringOptional
isDisableWallpapaerstringOptional
isPromptEnabledstringOptional
idleTimeoutintegerOptional
isIdleSessionTimeoutstringOptional
isMultiConnEnabledbooleanOptional
compressionTypestringOptional
colorQualitystringOptional
branchOfficeIDstringOptional

RoleId. Get Role Id

branchOfficeNamestringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
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

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

Response Parameters

- HTTP code 200

Response Body - application/json
JSON Object
Hide Sub-Attributes
statusstring

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "status": "success"
  }
                
Show full

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.