Configure Proxy
Partners
Configure Proxy
Configures the proxy URL and enables or disables the use of proxy on the instance
PUT
Configure Proxy
Overview
Method used to configure both the proxy URL and the option to enable proxy usage on the instance.The current values configured for
proxyUrl and useProxy on the instance can be checked at the Instance Data endpoint.Parameters
string
required
Your instance ID. Available in the Z-API panel under Instances.
string
required
Your Z-API instance token.
Attributes
string
required
Proxy URL to be used by the instance.
boolean
required
Defines whether the configured proxy should be enabled (
true) or disabled (false).If there is no
proxyUrl configured, the enable field has no effect. The absence of a configured proxy URL will result in the instance connecting without using a proxy, regardless of the value of enable.