Retrieves WebSocket server port details (SSL and non-SSL ports, gateway name) required to establish WebSocket connections for remote control, chat, and system manager sessions.
get /dcapi/tools/ws/wsProperties
https://{serverurl}/dcapi/tools/ws/wsProperties
Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52
curl --request GET \
--url https://appdomains/dcapi/tools/ws/wsProperties \
--header 'Accept: application/json' \
--header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52'WebSocket SSL port number
WebSocket non-SSL port number
Gateway server hostname
Whether SSL is enabled for WebSocket connections
{
"wsSSLPort": 8383,
"isSslEnabled": true,
"gatewayName": "dc-gateway-01",
"wsNonSSLPort": 8020
}
![]()
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.