Returns the on-premise WebSocket port configuration details required for establishing tool connections such as remote control, chat, and system manager sessions.
get /dcapi/tools/wsPortDetails
https://{server-hostname}:8383/dcapi/tools/wsPortDetails Copied!
Authorization: d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomain/dcapi/tools/wsPortDetails \
--header 'Accept: application/json' \
--header 'Authorization: d92d4xxxxxxxxxxxxx15f52'WebSocket SSL port number
WebSocket non-SSL port number
SSL port availability status: 1=Available, 0=Unavailable
Non-SSL port availability status: 1=Available, 0=Unavailable
Whether SSL is enabled for WebSocket connections
{
"wsSSLPortStatus": 1,
"wsSSLPort": 8383,
"isSslEnabled": true,
"wsNonSSLPort": 8020,
"wsNonSSLPortStatus": 1
}
![]()
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.