Skip to main content
POST
Configure proxy

Authorizations

apikey
string
header
required

Your Pilot Status API key (ps_...). Evolution GO also accepts Authorization: Bearer <key>.

Path Parameters

instance
string
required

The number's display name in the Pilot Status dashboard.

Body

application/json
enabled
boolean
required

Whether the proxy is enabled for this instance.

Example:

true

host
string
required

Proxy host name or IP address.

Example:

"proxy.example.com"

port
string
required

Proxy port.

Example:

"8080"

protocol
string
required

Proxy protocol (e.g. http, https, socks5).

Example:

"http"

username
string

Username for proxy authentication.

Example:

"proxyuser"

password
string

Password for proxy authentication.

Example:

"proxypass"

Response

Success — provider-native response body.

Confirmation that the instance proxy configuration was saved. Echoes the instance name and the proxy payload that was persisted.

proxy
object