Retrieves the screen recording configuration for remote control sessions

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 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

RemoteControl.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

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

Response Parameters

- HTTP code 200

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

Screen recording: 0=Disabled, 1=Enabled

framesPerSecinteger

Recording frame rate

codecTypeinteger

Video codec type identifier

colorQualityinteger

Color quality level

recMaintainsSizeinteger

Maximum storage size in MB for recordings. Range: 1-1000

driveFreeSpaceinteger

Minimum free space check: 0=Disabled, 1=Enabled

isAuthVideoDownloadinteger

Authenticated video download: 0=Disabled, 1=Enabled

isNotifyUserEnabledinteger

Notify end user about recording: 0=Disabled, 1=Enabled

notifyMessagestring

Notification message shown to the end user during recording

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "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.