Retrieves WebSocket port details for on-premise tool session connections Returns the on-premise WebSocket port configuration details required for establishing tool connections such as remote control, chat, and system manager sessions.
Request URL https://{server-hostname}:8383/dcapi/tools/wsPortDetails
Scope
Header Authorization: d92d4xxxxxxxxxxxxx15f52
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/wsPortDetails \
--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/wsPortDetails"))
.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/wsPortDetails", 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/wsPortDetails"
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/wsPortDetails' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes wsSSLPort integer
WebSocket SSL port number
wsNonSSLPort integer
WebSocket non-SSL port number
wsSSLPortStatus integer
SSL port availability status: 1=Available, 0=Unavailable
wsNonSSLPortStatus integer
Non-SSL port availability status: 1=Available, 0=Unavailable
isSslEnabled boolean
Whether SSL is enabled for WebSocket connections
Possible Response Codes Sample Response: HTTP 200 {
"wsSSLPortStatus": 1,
"wsSSLPort": 8383,
"isSslEnabled": true,
"wsNonSSLPort": 8020,
"wsNonSSLPortStatus": 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.