Retrieves the gateway and file transfer port settings for on-premise tool connections Returns the current gateway port settings including SSL and non-SSL ports for remote control and file transfer connections.
Request URL https://{server-hostname}:8383/dcapi/tools/portSetting
Request Parameters - Request Headers Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request GET \
--url https://appdomain/dcapi/tools/portSetting \
--header 'Accept: application/json'import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;
public class Main {
public static void main(String[] args) {
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://appdomain/dcapi/tools/portSetting"))
.header("Accept", "application/json")
.method("GET", HttpRequest.BodyPublishers.noBody())
.build();
HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
}
}
import http.client
conn = http.client.HTTPSConnection("appdomain")
headers = { 'Accept': "application/json" }
conn.request("GET", "/dcapi/tools/portSetting", headers=headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))
headersMap = Map();
headersMap.put("Accept", "application/json");
response = invokeUrl
[
url: "https://appDomain/dcapi/tools/portSetting"
type: GET
headers: headersMap
connection: connection_name
]
info response;
$headers=@{}
$headers.Add("Accept", "application/json")
$response = Invoke-WebRequest -Uri 'https://appdomain/dcapi/tools/portSetting' -Method GET -Headers $headersResponse Parameters - HTTP code 200 Response Body - application/json JSON Object
Hide Sub-Attributes gatewaySSLPort integer
Gateway SSL port for remote control connections
gatewayNonSSLPort integer
Gateway non-SSL port for remote control connections
ftNonSSLPort integer
File transfer non-SSL port
useSSL boolean
Whether SSL is enabled for gateway connections
Possible Response Codes Sample Response: HTTP 200 {
"gatewayNonSSLPort": 80,
"ftSSLPort": 8443,
"ftNonSSLPort": 8020,
"gatewaySSLPort": 443,
"useSSL": true
}
▼ 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.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.
© 2026, Zoho Corporation Pvt. Ltd. All Rights Reserved.