# Retrieves WebSocket port details required for tool session connections

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

`GET /dcapi/tools/ws/wsProperties`

## Request URL

`https://{serverurl}/dcapi/tools/ws/wsProperties`

[{serverurl}](https://www.manageengine.com/products/desktop-central/help/api/cloud/oauth-authentication-endpoint-domain.html)

## Scope

`DesktopCentralCloud.Tools.READ`

## Header

`Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52`

## Request Parameters

### Request Headers

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

## Sample Request

```curl
curl --request GET \
  --url https://appdomains/dcapi/tools/ws/wsProperties \
  --header 'Accept: application/json' \
  --header 'Authorization: Zoho-oauthtoken  d92d4xxxxxxxxxxxxx15f52'
```

## Response Parameters

### HTTP Code 200

Response Body — `application/json`

`JSON Object`

- **wsSSLPort** `integer`: WebSocket SSL port number
- **wsNonSSLPort** `integer`: WebSocket non-SSL port number
- **gatewayName** `string`: Gateway server hostname
- **isSslEnabled** `boolean`: Whether SSL is enabled for WebSocket connections

## Possible Response Codes

- **200** `HTTP code`

## Sample Response: HTTP 200

```json
{
  "wsSSLPort": 8383,
  "isSslEnabled": true,
  "gatewayName": "dc-gateway-01",
  "wsNonSSLPort": 8020
}
```

![](https://www.zohowebstatic.com/sites/zweb/images/people/ico-help.png)

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