Retrieves the properties required to initiate a remote control session

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

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/properties \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

Remote viewer type in use: HTML5 or ActiveX

isGatewayAvailableboolean

true if the gateway server is reachable and available

isChatEnabledboolean

true if in-session chat is enabled for remote control

isFileTransferEnabledboolean

true if file transfer is enabled during remote sessions

isScreenRecordingEnabledboolean

true if screen recording is configured for remote sessions

isMultiSessionEnabledboolean

true if multiple simultaneous remote sessions are allowed

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

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