Retrieves the properties required to initiate a remote control session Returns the remote control feature properties for the current technician, including viewer type preferences, gateway availability, and session capabilities needed before initiating a remote session.
Request URL https://{server-hostname}:8383/dcapi/tools/remoteControl/properties
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/remoteControl/properties \
--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/properties"))
.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/properties", 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/properties"
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/properties' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes viewerType string
Remote viewer type in use: HTML5 or ActiveX
isGatewayAvailable boolean
true if the gateway server is reachable and available
isChatEnabled boolean
true if in-session chat is enabled for remote control
isFileTransferEnabled boolean
true if file transfer is enabled during remote sessions
isScreenRecordingEnabled boolean
true if screen recording is configured for remote sessions
isMultiSessionEnabled boolean
true if multiple simultaneous remote sessions are allowed
Possible Response Codes Sample Response: HTTP 200 {
"viewerType": "HTML5",
"isChatEnabled": true,
"isScreenRecordingEnabled": true,
"isGatewayAvailable": true,
"isFileTransferEnabled": true,
"isMultiSessionEnabled": false
}
▼ 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.