Sign in

v48

latestOpenAPI 3.0.0raw.githubusercontent.com2025-12-0297180624.8 KB
Box

Set proxy

Configures the HTTP proxy settings for a specific box. Use this endpoint when you need the box's outbound network traffic to pass through a proxy server.

post/boxes/{boxId}/proxy

Path parameters

boxIdstring required
Example:c9bdc193-b54b-4ddb-a035-5ac0c598d32d

Box ID

Request body

excludesstring[]

List of IP addresses and domains that should bypass the proxy. These addresses will be accessed directly without going through the proxy server. Default is ['127.0.0.1', 'localhost']

hoststring required

The host address of the proxy server

portnumber required

The port number of the proxy server

pacUrlstring

PAC (Proxy Auto-Configuration) URL.

Example request

{
  "auth": {
    "username": "admin",
    "password": "password"
  },
  "excludes": [
    "127.0.0.1",
    "localhost"
  ],
  "host": "127.0.0.1",
  "port": 8080,
  "pacUrl": "http://proxy.company.com/proxy.pac"
}

Response

Proxy set

excludesstring[]

List of IP addresses and domains that should bypass the proxy. These addresses will be accessed directly without going through the proxy server. Default is ['127.0.0.1', 'localhost']

hoststring required

The host address of the proxy server

portnumber required

The port number of the proxy server

pacUrlstring

PAC (Proxy Auto-Configuration) URL.

Example response

{
  "auth": {
    "username": "admin",
    "password": "password"
  },
  "excludes": [
    "127.0.0.1",
    "localhost"
  ],
  "host": "127.0.0.1",
  "port": 8080,
  "pacUrl": "http://proxy.company.com/proxy.pac"
}