Proxy

Get

Retrieve the proxy settings

GET/api/ProxySettings

Query parameters

Response

200401404

Success

Body

application/json; api-version=1.0

httpProxyModeProxyMode (enum)

HTTP Proxy Mode

0 = NoProxy,1 = ManualSettings

httpProxyAddressnullable string

The HTTP Proxy Address.

httpProxyUsernullable string

The HTTP Proxy User.

httpProxyPortinteger (int32)

The HTTP Proxy Port.

httpProxyRequiresAuthboolean

Whether HTTP Proxy requires authentication or not.

Request

JavaScriptCurlPython

const response = await fetch('/api/ProxySettings', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200401404

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

Update

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

PUT/api/ProxySettings

Query parameters

Body

application/json; api-version=1.0

Proxy Settings

apLockboolean

siteIdinteger (int32)

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

httpProxyModeProxyMode (enum)

HTTP Proxy Mode

0 = NoProxy,1 = ManualSettings

httpProxyAddressnullable string

HTTP Proxy Address.

httpProxyPortnullable integer (int32)

A custom Proxy port number.

httpProxyPwdnullable string

HTTP Proxy Password.

httpProxyUsernullable string

HTTP Proxy User.

httpProxyRequiresAuthnullable boolean

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

Response

204401404

No Content

Request

JavaScriptCurlPython

const response = await fetch('/api/ProxySettings', {
    method: 'PUT',
    headers: {
      "Content-Type": "application/json; api-version=1.0"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

401404

{
  "type": "text",
  "title": "text",
  "detail": "text",
  "instance": "text"
}