Skip to main content
POST
cURL

Body

application/json
name
string
required

The name of the proxy.

Required string length: 1 - 64
trafficPolicy
enum<string>
default:any-host

Which hosts an agent may reach through this proxy. any-host lets every request out; bundle-hosts allows only hosts an access bundle covers, plus anything in allowedHosts, and refuses the rest with a 403.

Available options:
any-host,
bundle-hosts
allowedHosts
string | null

Hosts that stay reachable under the bundle-hosts traffic policy even though no access bundle covers them. Still intercepted, and given no credential.

Maximum string length: 1024
pollInterval
integer
default:60

How often, in seconds, the proxy refreshes its sessions and settings. Between 10 and 300.

Required range: 10 <= x <= 300

Response

Default Response

proxy
Admin view · object
required
proxyToken
string
required

The token the proxy starts with, on as many machines as you need. Shown once, and works until it is rotated or the proxy's access is revoked.