Skip to content
ProxyRequest/ DOCS

Proxy Gateway Quickstart

This guide covers proxy connectivity after a package and credentials already exist. To configure the operator path from provider to customer first, use the Platform Quickstart.

Every value below is deployment-neutral. Replace the host, ports, package username, and password with the credentials issued for your environment.

Before you start

Section titled “Before you start”

You need four values from the dashboard or onboarding record:

ValuePurpose
Proxy hostGateway hostname assigned to the deployment
HTTP and SOCKS5 portsConnection ports can differ by protocol
Package usernameBase username for an active order or package
Proxy passwordSecret used by the gateway, not your dashboard password

Make a request

Section titled “Make a request”
RequestGET https://api.ipify.org?format=json
curl 'https://api.ipify.org?format=json' \
  --proxy 'http://{proxy_username}:{proxy_password}@{proxy_host}:{proxy_port}'
Response200 OK
{
  "ip": "203.0.113.42"
}

Replace placeholders in braces with your values. Responses use synthetic example data.

An HTTP proxy also carries HTTPS targets through the CONNECT method. The target URL stays https://; the proxy URL stays http://.

Target a continent

Section titled “Target a continent”

Use continent-{code} when any eligible country inside a continent satisfies the request. Retrieve the code from GET /locations/continents for the selected package.

RequestGET https://api.ipify.org?format=json
curl 'https://api.ipify.org?format=json' \
  --proxy 'http://package-elite-continent-eu:{proxy_password}@{proxy_host}:{proxy_port}'
Response200 OK
{
  "ip": "203.0.113.42"
}

Replace placeholders in braces with your values. Responses use synthetic example data.

Continent targeting stands alone: do not combine it with country, region, city, ASN, or ISP tokens.

SAFE SANDBOX

Compose a proxy request

PLACEHOLDERS ONLY
cURL
curl --proxy 'http://package-elite-country-us:{proxy_password}@proxy.your-domain.example:8000' 'https://api.ipify.org?format=json'

Keep credentials server-side.Never embed a proxy password in frontend code or a public repository.

Read the credential from left to right

Section titled “Read the credential from left to right”
  1. Start with the package username, for example package-elite.
  2. Append either a continent token such as continent-eu or a country token such as country-us.
  3. Add region, city, or ASN targeting only after choosing the country form.
  4. Add sid-{value} when several requests must try to reuse one exit session.
  5. Add ttl-{seconds} only together with a session ID.

The complete pattern is:

{package}-continent-{continent}-sid-{session}-ttl-{seconds}
{package}-country-{cc}-region-{region}-city-{city}-asn-{asn}-sid-{session}-ttl-{seconds}

Choose one of these location forms and omit every token you do not use. A broader request usually has more eligible exits than a narrowly targeted request.

Verify the result

Section titled “Verify the result”

The test target should return a public exit IP. Run the same command twice and check:

  • the request succeeds without a 407 Proxy Authentication Required response;
  • the returned IP differs from the client machine;
  • the continent, country, or network matches the requested targeting when inventory is available;
  • a repeated sticky-session request behaves consistently enough for the application.

Continue the integration

Section titled “Continue the integration”