# 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.

## Endpoint

`GET /dcapi/tools/wsPortDetails`

## Request

### Request URL

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

### Scope

`Tools.READ`

### Header

`Authorization: d92d4xxxxxxxxxxxxx15f52`

### Request Parameters

#### Request Headers

- **Accept** `string` — **Mandatory**  
  `application/json`

### Sample Request

```curl
curl --request GET \
  --url https://appdomain/dcapi/tools/wsPortDetails \
  --header 'Accept: application/json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52'
```

## Response

### Response Parameters

#### HTTP code 200

Response Body — `application/json`

`JSON Object`

- **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

- **200** — HTTP code

### Sample Response: HTTP 200

```json
{
  "wsSSLPortStatus": 1,
  "wsSSLPort": 8383,
  "isSslEnabled": true,
  "wsNonSSLPort": 8020,
  "wsNonSSLPortStatus": 1
}
```

## API Rate Limits

**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.