Retrieves WebSocket port details for on-premise 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

Returns the on-premise WebSocket port configuration details required for establishing tool connections such as remote control, chat, and system manager sessions.

Endpoints

Request URL

https://{server-hostname}:8383/dcapi/tools/wsPortDetails

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/wsPortDetails \
  --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

wsSSLPortStatusinteger

SSL port availability status: 1=Available, 0=Unavailable

wsNonSSLPortStatusinteger

Non-SSL port availability status: 1=Available, 0=Unavailable

isSslEnabledboolean

Whether SSL is enabled for WebSocket connections

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "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.