Retrieves WebSocket port details required for tool session connections

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

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.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/tools/ws/wsProperties

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/jsonapplication/jsonCopied!

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
  --url https://appdomain/dcapi/tools/ws/wsProperties \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'

Response Parameters

- HTTP code 200

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

WebSocket SSL port number

wsNonSSLPortinteger

WebSocket non-SSL port number

gatewayNamestring

Gateway server hostname

isSslEnabledboolean

Whether SSL is enabled for WebSocket connections

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "wsSSLPort": 8383,
    "isSslEnabled": true,
    "gatewayName": "dc-gateway-01",
    "wsNonSSLPort": 8020
  }
                
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.