Retrieves the user confirmation prompt settings for remote control sessions 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
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/remoteControl/rdsPromptSettings \
--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/rdsPromptSettings"))
.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/rdsPromptSettings", 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/rdsPromptSettings"
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/rdsPromptSettings' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes isPromptEnabled integer
User confirmation prompt: 0=Disabled, 1=Enabled
promptTimeOut integer
Prompt auto-dismiss timeout in seconds
promptMessage string
Custom message displayed in the user confirmation dialog
isAlwaysPrompt integer
Always show prompt: 0=No, 1=Yes
isPromptPermanent integer
Permanent prompt mode: 0=Disabled, 1=Enabled
Possible Response Codes Sample Response: HTTP 200 {
"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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.