Retrieves the global remote control configuration settings 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://{server-hostname}:8383/dcapi/tools/remoteControl/rdsSettings
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/remoteControl/rdsSettings \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/tools/remoteControl/rdsSettings"))
.header("Accept", "application/json")
.header("Authorization", " d92d4xxxxxxxxxxxxx15f52")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = {
'Accept': "application/json",
'Authorization': " d92d4xxxxxxxxxxxxx15f52"
}
conn.request("GET", "/dcapi/tools/remoteControl/rdsSettings", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://appDomain/dcapi/tools/remoteControl/rdsSettings"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/json")
$headers.Add("Authorization", " d92d4xxxxxxxxxxxxx15f52")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/remoteControl/rdsSettings' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes viewerType string
Remote viewer type: HTML5 or ActiveX
gatewayNonSSLPort integer
Gateway non-SSL port number
wsSSLPort integer
WebSocket SSL port number
wsNonSSLPort integer
WebSocket non-SSL port number
isMultiConnEnabled boolean
Whether multiple simultaneous connections are allowed
endUserDisconnect integer
End user disconnect policy: 0=Disabled, 1=Enabled
isPromptEnabled integer
User confirmation prompt: 0=Disabled, 1=Enabled
idleTimeout integer
Idle session timeout in minutes. Range: 1-120
isIdleSessionTimeout integer
Idle timeout action: 0=Disabled, 1=Enabled
useSSL integer
SSL usage: 0=Disabled, 1=Enabled
isTomcatGatewayEnabled boolean
Whether Tomcat gateway mode is active
Possible Response Codes Sample Response: HTTP 200 {
"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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.