Proxy

The Proxy object is used to get and set data for HTTP/HTTPS proxy settings on the TSW-70 series device.

Syntax

  • HTTP Methods: GET, POST
  • Base URI: /Device/Proxy/

Properties

Property Name Parent Path Version Description Type Methods Validation Rules
Proxy /Device/ 2.0.0 The top‑level Proxy object. Object N/A N/A
IsEnabled /Device/Proxy/ 2.0.0

Indicates whether proxy support is enabled (true) or disabled (false).

If set to true, HTTP or HTTPS proxy settings must be specified.

 Boolean GET, POST N/A
IsExcludeLocalEnabled /Device/Proxy/ 2.1.0 Indicates whether proxy server bypass is enabled (true) or disabled (false) for the local address. Boolean GET, POST N/A
HttpSettings /Device/Proxy/ 2.0.0 The HTTP proxy subobject. Child settings are available only if IsEnabled is set to true. Object N/A N/A
IsEnabled /Device/Proxy/HttpSettings/ 2.0.0 Indicates whether nonsecure proxy support is enabled (true) or disabled (false).

If set to true, an address and port must be specified.		 Boolean GET, POST N/A
Address /Device/Proxy/HttpSettings/ 2.0.0 The nonsecure proxy IP address or hostname. String GET, POST A valid IP address or hostname
Port /Device/Proxy/HttpSettings/ 2.0.1 The port of the nonsecure proxy connection. Numeric (Unsigned 16-bit) GET, POST 1–65535
Username /Device/Proxy/HttpSettings/ 2.0.2 The username for the nonsecure proxy connection. String GET, POST 0–128 characters,
Valid characters: a–z, A–Z, 0–9, "_", ",", ".", "/", "-"
Password /Device/Proxy/HttpSettings/ 2.0.2 The password for the nonsecure proxy connection. String GET, POST 0–128 characters,
All printable characters are allowed
HttpsSettings /Device/Proxy/ 2.0.0 The HTTPS proxy subobject. Child settings are available only if IsEnabled is set to true. Object N/A N/A
IsEnabled /Device/Proxy/HttpsSettings/ 2.0.0 Indicates whether secure proxy support is enabled (true) or disabled (false).

If set to true, an address and port must be specified.		 Boolean GET, POST N/A
Address /Device/Proxy/HttpsSettings/ 2.0.0 The secure proxy IP address or hostname. String GET, POST A valid IP address or hostname
Port /Device/Proxy/HttpsSettings/ 2.0.1 The port of the secure proxy connection. Numeric (Unsigned 16-bit) GET, POST 1–65535
Username /Device/Proxy/HttpsSettings/ 2.0.2 The username for the secure proxy connection. String GET, POST 0–128 characters,
Valid characters: a–z, A–Z, 0–9, "_", ",", ".", "/", "-"
Password /Device/Proxy/HttpsSettings/ 2.0.2 The password for the secure proxy connection. String GET, POST 0–128 characters,
All printable characters are allowed
Version /Device/Proxy/ 2.2.0 The object version.

"2.0.0": Initial public release,
"2.0.1": Added Ports property,
"2.0.2": Moved Username and Password properties into HTTP/HTTPS settings,
"2.0.3": Updated validation rules for Username, Password, and Port properties,
"2.1.0": Added IsExcludeLocalEnabled property,
"2.2.0": Added ProxyAllowDomains dictionary.		 String GET N/A

Example JSON

The following example JSON uses the current object version (2.2.0).

Copy 
{
    "Device": {
        "Proxy": {
            "HttpSettings": {
                "Address": "<address>",
                "IsEnabled": true,
                "Password": "",
                "Port": 80,
                "Username": "admin"
            },
            "HttpsSettings": {
                "Address": "<address>",
                "IsEnabled": true,
                "Password": "",
                "Port": 443,
                "Username": "admin"
            },
            "IsEnabled": false,
            "IsExcludeLocalEnabled": true,
            "Version": "2.2.0"
        }
    }
}