Skip to main content
The Switch Proxy command (Command Type: 999) configures proxy settings for the browser scraper, with support for link-based proxy assignment.

Command Type

Command Type ID: 999

Parameters

ParameterTypeDescriptionRequired
serverstringProxy server address (host:port or URL)Yes
timeoutnumberTimeout in millisecondsYes
bypassstringComma-separated domains to bypass proxy (e.g., ".com, chromium.org")No
linkOptionsLinkOptionsGet proxy from a LINK configurationNo
passwordstringPassword for HTTP proxy authenticationNo
timezonestringTimezone of the proxy in IANA formatNo
usernamestringUsername for HTTP proxy authenticationNo

LinkOptions

FieldTypeDescriptionRequired
consumerNamestringName of the consumer using the linkYes
countriesArray of stringCountries for the LINK target (ISO codes)Yes
endpointstringEndpoint associated with LINKYes
isValidationbooleanWhether the LINK target uses validationYes
targetIdstringIdentifier for the LINK targetYes
fallbackProxyFallbackProxyOptional fallback proxyNo
fingerprintIdnumberFingerprint identifierNo
labelsobjectMetrics labels (key-value pairs)No

Usage Examples

Set a Direct Proxy

{
  "command": "switch-proxy",
  "params": {
    "server": "proxy.example.com:8080",
    "timeout": 10000,
    "username": "user",
    "password": "%{PROXY_PASSWORD}"
  }
}
{
  "command": "switch-proxy",
  "params": {
    "server": "proxy.link.example.com:8080",
    "timeout": 10000,
    "linkOptions": {
      "consumerName": "scraper-1",
      "countries": ["US"],
      "endpoint": "proxy-endpoint",
      "isValidation": false,
      "targetId": "proxy-target-id"
    }
  }
}