Retrieves 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

Returns the remote control configuration including viewer type, gateway SSL/non-SSL ports, WebSocket ports, connection policies (multi-connect, prompt, end-user disconnect), performance options, and idle session timeout settings.

Request URL

https://{serverurl}/dcapi/tools/remoteControl/rdsSettings

Scope

DesktopCentralCloud.RemoteControl.READCopied!

Header

Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomains/dcapi/tools/remoteControl/rdsSettings \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Remote viewer type: HTML5 or ActiveX

gatewaySSLPortinteger

Gateway SSL port number

gatewayNonSSLPortinteger

Gateway non-SSL port number

wsSSLPortinteger

WebSocket SSL port number

wsNonSSLPortinteger

WebSocket non-SSL port number

isMultiConnEnabledboolean

Whether multiple simultaneous connections are allowed

endUserDisconnectinteger

End user disconnect policy: 0=Disabled, 1=Enabled

isPromptEnabledinteger

User confirmation prompt: 0=Disabled, 1=Enabled

idleTimeoutinteger

Idle session timeout in minutes. Range: 1-120

isIdleSessionTimeoutinteger

Idle timeout action: 0=Disabled, 1=Enabled

useSSLinteger

SSL usage: 0=Disabled, 1=Enabled

isTomcatGatewayEnabledboolean

Whether Tomcat gateway mode is active

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "gatewayNonSSLPort": 80,
    "wsSSLPort": 8383,
    "viewerType": "HTML5",
    "wsNonSSLPort": 8020,
    "endUserDisconnect": 1,
    "idleTimeout": 30,
    "isIdleSessionTimeout": 1,
    "isTomcatGatewayEnabled": true,
    "isMultiConnEnabled": true,
    "gatewaySSLPort": 443,
    "isPromptEnabled": 1,
    "useSSL": 1
  }
                
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.