Retrieves the user confirmation prompt settings 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 user confirmation prompt configuration for remote control, including whether prompting is enabled, prompt timeout duration, blank screen on connect, keyboard/mouse lock, permanent prompt, and idle session timeout settings.

Request URL

https://{server-hostname}:8383/dcapi/tools/remoteControl/rdsPromptSettings

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

Response Parameters

- HTTP code 200

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

User confirmation prompt: 0=Disabled, 1=Enabled

promptTimeOutinteger

Prompt auto-dismiss timeout in seconds

promptMessagestring

Custom message displayed in the user confirmation dialog

isAlwaysPromptinteger

Always show prompt: 0=No, 1=Yes

isPromptPermanentinteger

Permanent prompt mode: 0=Disabled, 1=Enabled

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "promptTimeOut": 30,
    "isShowBlankScreen": 1,
    "isLockKeyboardMouse": 1,
    "idleTimeout": 30,
    "isAlwaysPrompt": 0,
    "promptMessage": "A technician is requesting remote access to your computer.",
    "isPromptPermanent": 0,
    "isPromptEnabled": 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.