Get started with BlackieShield

HTTP Proxy

Route browser or application traffic through BlackieShield HTTP proxy servers. Works with any client that supports standard HTTP proxy settings.

# Set your shell proxy (replace with your credentials)
export http_proxy="http://YOUR_API_KEY@proxy.blackieshield.com:8080"
export https_proxy="http://YOUR_API_KEY@proxy.blackieshield.com:8080"

# Verify your proxy connection
curl -x http://YOUR_API_KEY@proxy.blackieshield.com:8080 https://api.ipify.org

SOCKS5 Proxy

Use SOCKS5 for full TCP-level proxying. Ideal for applications, torrent clients, and tools that need protocol-level tunnelling.

# SOCKS5 with curl
curl --socks5 proxy.blackieshield.com:1080 \
  --proxy-user YOUR_API_KEY: \
  https://api.ipify.org

# SOCKS5 environment variable
export ALL_PROXY="socks5://YOUR_API_KEY@proxy.blackieshield.com:1080"

Desktop (Windows / macOS / Linux)

Download the WireGuard client for your operating system, then import the configuration file from your BlackieShield dashboard.

1. 1Install WireGuard from wireguard.com/install
2. 2Log in to your BlackieShield dashboard and go to VPN > Download Config
3. 3Open WireGuard and click "Import tunnel(s) from file"
4. 4Select the downloaded .conf file and activate the tunnel

Mobile (iOS / Android)

Install the WireGuard app from your device's app store and scan the QR code from your dashboard.

1. 1Install WireGuard from the App Store or Google Play
2. 2Log in to your BlackieShield dashboard on a computer
3. 3Go to VPN > Show QR Code
4. 4Open WireGuard on your phone and tap + > Scan from QR Code

Chrome / Edge / Firefox

The BlackieShield browser extension provides one-click proxy configuration. It automatically manages your API key, whitelists your IP, and toggles proxy settings without touching system-level config.

1. 1Download the extension from your dashboard (Setup Guide section)
2. 2Open your browser's extension management page (chrome://extensions or about:addons)
3. 3Enable "Developer mode" and click "Load unpacked" (Chrome/Edge) or "Load Temporary Add-on" (Firefox)
4. 4Select the downloaded extension folder
5. 5Click the BlackieShield icon in your toolbar and sign in

Authentication

All API requests require a valid API key passed in the Authorization header. Generate and manage keys from your dashboard.

# Include your API key in every request
curl -X GET "https://api.blackieshield.com/proxy/status" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json"

Proxy Authentication

When connecting through the proxy, pass your API key via the Proxy-Authorization header.

# Proxy with Bearer token
curl -x http://proxy.blackieshield.com:8080 \
  -H "Proxy-Authorization: Bearer YOUR_API_KEY" \
  https://api.ipify.org

Check Connection Status

Verify your proxy or VPN session is active and see remaining quota.

curl -X GET "https://api.blackieshield.com/proxy/status" \
  -H "Authorization: Bearer YOUR_API_KEY"

# Response
{
  "status": "active",
  "service": "proxy",
  "server": "us-east-1",
  "bandwidthUsed": "1.2 GB",
  "bandwidthRemaining": "48.8 GB"
}