Updates the user confirmation prompt settings for remote control

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

Saves the user confirmation prompt configuration, including whether prompting is enabled, the prompt timeout, blank screen and keyboard/mouse lock on connect, permanent prompt mode, and idle session timeout action.

Request URL

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

Scope

RemoteControl.UPDATECopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/rdsPromptSettingsStatus.v1+jsonapplication/rdsPromptSettingsStatus.v1+jsonCopied!
Content-TypestringMandatory
application/rdsPromptSettingsInfo.v1+jsonapplication/rdsPromptSettingsInfo.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
isPromptEnabledstringOptional
promptTimeOutstringOptional
promptMessagestringOptional
isAlwaysPromptstringOptional
isPromptPermanentstringOptional
excludeServerMachinesstringOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/dcapi/tools/remoteControl/rdsPromptSettings \
  --header 'Accept: application/rdsPromptSettingsStatus.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/rdsPromptSettingsInfo.v1+json' \
  --data '{"promptTimeOut":30,"isAlwaysPrompt":0,"promptMessage":"A technician is requesting remote access.","isPromptPermanent":0,"isPromptEnabled":1}'

Sample Request Body

Copied!
  {
    "promptTimeOut": 30,
    "isAlwaysPrompt": 0,
    "promptMessage": "A technician is requesting remote access.",
    "isPromptPermanent": 0,
    "isPromptEnabled": 1
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "status": "success"
  }
                
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.