Proxy

PreviousAuto Install Fonts NextScanning

Was this helpful?

Get

get

Retrieve the proxy settings

Query parameters

siteIdinteger · int32optional

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --url '/api/ProxySettings'

200

401

404

{
  "httpProxyMode": [
    "0 = NoProxy",
    "1 = ManualSettings"
  ],
  "httpProxyAddress": "text",
  "httpProxyUser": "text",
  "httpProxyPort": 1,
  "httpProxyRequiresAuth": true
}

Success

Update

put

Modify Proxy Settings. For each setting, the request has a corresponding parameter. To modify a setting, specify a matching parameter and its value.

Query parameters

siteIdinteger · int32optional

Site Id to retrieve Proxy Settings

Body

apLockbooleanoptional

siteIdinteger · int32optional

The site ID. To obtain the ID of a desired site, use the Get-Sites cmdlet.

httpProxyModestring · enumoptional

HTTP Proxy Mode

Available options:

httpProxyAddressstring | nullableoptional

HTTP Proxy Address.

httpProxyPortinteger · int32 | nullableoptional

A custom Proxy port number.

httpProxyPwdstring | nullableoptional

HTTP Proxy Password.

httpProxyUserstring | nullableoptional

HTTP Proxy User.

httpProxyRequiresAuthboolean | nullableoptional

HTTP Proxy Requires Authentication: Enable (True) or disable (False).

Responses

application/json; api-version=1.0

cURL

JavaScript

Python

HTTP

curl -L \
  --request PUT \
  --url '/api/ProxySettings' \
  --header 'Content-Type: application/json; api-version=1.0' \
  --data '{
    "apLock": true,
    "siteId": 1,
    "httpProxyMode": [
      "0 = NoProxy",
      "1 = ManualSettings"
    ],
    "httpProxyAddress": "text",
    "httpProxyPort": 1,
    "httpProxyPwd": "text",
    "httpProxyUser": "text",
    "httpProxyRequiresAuth": true
  }'

204

401

404

No Content