Parameters
The username used for proxy requests to your zones allows you to pass various parameters to affect how that request is handled. For example you may specify a country, IP (for reserved datacenter zones with dedicated IP pools) or session ID.
To view live code samples and experiment with different zone parameters, select a zone on the integrations page of the dashboard.
Making a request
The following basic rules apply to all proxy requests you make to your zones.
Proxy address
The entry point for all proxy requests to Bytio is proxy.bytio.com
on port 8080
(to connect to the proxy over HTTP) or port 8443
(to connect to the proxy over HTTPS).
Password
Your API key is your proxy password. You can view or reset your API key on the profile page of the dashboard.
Example
For a zone with ID ABCDEF
, the zone request username would be:
A full curl command to run a request against the Bytio IP-checking endpoint would be:
Parameters
Additional parameters can be specified in the zone username, delimited with hyphens. For example, to route requests through a proxy IP in the United States, for a zone with ID ABCDEF
, the zone request username would be:
You can specify multiple parameters in your username - all delimited with hyphens. For example, to route requests through a proxy IP in the United States, with session ID mysession1
, for a zone with ID ABCDEF
, the zone request username would be:
A full list of zone username parameters is shown below.
Parameter | Description |
---|---|
country | The country code of the country in which the datacenter IP, mobile device or residential proxy used to service the request should exist. For more information, see countries. For example: zone-ABCDEF-country-us |
session | The session ID to use if a persistent session is required. For more information, see sessions. A session ID can be any alphanumeric string up to 50 characters long. For example: zone-ABCDEF-session-mysession1 |
ip | When using a Reserved datacenter zone, with an IP pool, use the ip parameter to specify the exact proxy IP to route requests through. For more information, see reserved IPs.For example, to route the request through proxy IP 162.19.50.13 the zone username would be: zone-ABCDEF-ip-162.19.50.13 |
To view live code samples and experiment with different zone parameters, select a zone on the integrations page of the dashboard.