ProductsSupportPartnersDocumentation

Proxy

Get

get

Retrieve the proxy settings

Query parameters
siteIdinteger · int32Optional
Responses
200
Success
application/json; api-version=1.0
get
GET /api/ProxySettings HTTP/1.1
Host: 
Accept: */*

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

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

Possible values:
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
204
No Content
put
PUT /api/ProxySettings HTTP/1.1
Host: 
Content-Type: application/json; api-version=1.0
Accept: */*
Content-Length: 197

{
  "apLock": true,
  "siteId": 1,
  "httpProxyMode": [
    "0 = NoProxy",
    "1 = ManualSettings"
  ],
  "httpProxyAddress": "text",
  "httpProxyPort": 1,
  "httpProxyPwd": "text",
  "httpProxyUser": "text",
  "httpProxyRequiresAuth": true
}
No content
PreviousAuto Install FontsNextScanning

Was this helpful?