Updates the gateway and file transfer port settings for on-premise tool 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

Saves the gateway SSL/non-SSL port and file transfer port settings. Accepts a JSON body with the port values and SSL preference. Used to configure the network ports for remote control and file transfer connections.

Endpoints

Request URL

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

Scope

Tools.READCopied!

Header

Authorization: d92d4xxxxxxxxxxxxx15f52

Request Parameters

- Request Headers

AcceptstringMandatory
application/toolsPortSavedDetails.v1+jsonapplication/toolsPortSavedDetails.v1+jsonCopied!
Content-TypestringMandatory
application/toolsPortSettingsDetails.v1+jsonapplication/toolsPortSettingsDetails.v1+jsonCopied!

- Request Body

application/json
JSON Object
Hide Sub-Attributes
gatewaySSLPortstringOptional

RoleId. Get Role Id

gatewayNonSSLPortstringOptional

RoleId. Get Role Id

ftSSLPortstringOptional

RoleId. Get Role Id

ftNonSSLPortstringOptional

RoleId. Get Role Id

useSSLbooleanOptional

Sample Request

Curl
Java
Python
Deluge
PowerShell
Copied!
curl --request PUT \
  --url https://appdomain/dcapi/tools/portSetting \
  --header 'Accept: application/toolsPortSavedDetails.v1+json' \
  --header 'Authorization:  d92d4xxxxxxxxxxxxx15f52' \
  --header 'Content-Type: application/toolsPortSettingsDetails.v1+json' \
  --data '{"gatewayNonSSLPort":80,"ftSSLPort":8443,"ftNonSSLPort":8020,"gatewaySSLPort":443,"useSSL":true}'

Sample Request Body

Copied!
  {
    "gatewayNonSSLPort": 80,
    "ftSSLPort": 8443,
    "ftNonSSLPort": 8020,
    "gatewaySSLPort": 443,
    "useSSL": true
  }
                
Show full

Response Parameters

- HTTP code 200

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

Result of the operation: success or failure

Possible Response Codes

200HTTP code

Sample Response: HTTP 200

Copied!
  {
    "status": "success"
  }
                
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.