Retrieves the screen recording configuration for remote control sessions Returns the screen recording settings for remote control sessions, including whether recording is enabled, frame rate, codec type, storage size limits, color quality, and whether authenticated video download is required.
Request URL https://{server-hostname}:8383/dcapi/tools/remoteControl/screenRecording
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/remoteControl/screenRecording \
--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/screenRecording"))
.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/screenRecording", 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/screenRecording"
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/screenRecording' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes isScreenRecEnabled integer
Screen recording: 0=Disabled, 1=Enabled
codecType integer
Video codec type identifier
recMaintainsSize integer
Maximum storage size in MB for recordings. Range: 1-1000
driveFreeSpace integer
Minimum free space check: 0=Disabled, 1=Enabled
isAuthVideoDownload integer
Authenticated video download: 0=Disabled, 1=Enabled
isNotifyUserEnabled integer
Notify end user about recording: 0=Disabled, 1=Enabled
notifyMessage string
Notification message shown to the end user during recording
Possible Response Codes Sample Response: HTTP 200 {
"isNotifyUserEnabled": 1,
"notifyMessage": "This session is being recorded.",
"isScreenRecEnabled": 1,
"framesPerSec": 15,
"recMaintainsSize": 500,
"codecType": 1,
"driveFreeSpace": 1,
"colorQuality": 2,
"isAuthVideoDownload": 0
}
▼ 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.