Settings
Configure Proxy
Sets, changes or REMOVES the instance proxy. The canonical field is `mode`: `custom` (your own proxy, requires proxy_url), `internal` (proxy managed by the service) or `none` (removes the proxy, requires confirm_no_proxy=true). To remove the proxy, send mode=none and confirm_no_proxy=true.
POST
https://api.zapzapapi.com/api/v1/{instanceId}/instance/proxyAuthentication with the x-api-key and x-api-secret headers.
Parameters
| Name | Type | In | Required | Description |
|---|---|---|---|---|
mode | select | body | Yes | Proxy strategy |
proxy_url | text | body | No | Proxy URL (required when mode=custom). Protocols: http://, https://, socks5:// |
proxy_fallback | text | body | No | Fallback for mode=custom (e.g. internal, never) |
confirm_no_proxy | select | body | No | Confirms proxy removal (required when mode=none) |
rotate_now | select | body | No | Rotates the internal proxy immediately (when mode=internal) |
Request example
curl
curl -X POST "https://api.zapzapapi.com/api/v1/{instanceId}/instance/proxy" \
-H "x-api-key: YOUR_API_KEY" \
-H "x-api-secret: YOUR_API_SECRET" \
-H "Content-Type: application/json" \
-d '{"mode":"custom"}'Node.js
const res = await fetch("https://api.zapzapapi.com/api/v1/{instanceId}/instance/proxy", {
method: "POST",
headers: {
"x-api-key": "YOUR_API_KEY",
"x-api-secret": "YOUR_API_SECRET",
"Content-Type": "application/json",
},
body: JSON.stringify({
"mode": "custom"
}),
});
console.log(await res.json());Python
import requests
res = requests.post(
"https://api.zapzapapi.com/api/v1/{instanceId}/instance/proxy",
headers={"x-api-key": "YOUR_API_KEY", "x-api-secret": "YOUR_API_SECRET"},
json={"mode":"custom"},
)
print(res.json())Response example
JSON
{
"details": "Proxy removido",
"proxy": {
"enabled": false
},
"restart_requested": true
}Values are illustrative; the fields follow the real response format.
Other endpoints in this category
Get your API keys
Create your account, connect a number in minutes and start using the API. R$15 per active number/month, with a welcome credit when you create the account, subject to the current campaign.