Skip to content

Quick Start Guide

Fresh

Get started with the Proxidize API in under 5 minutes.

Prerequisites

  • Proxidize server running and accessible
  • API token from Dashboard Settings
  • Proxidize Essential, Plus, or Business plan

Step 1: Get Your API Token

  1. Log into your Proxidize dashboard
  2. Navigate to Settings > API Token
  3. Copy your API token

Keep Your Token Secure

Never share your API token publicly. Treat it like a password.

Step 2: Test Authentication

Make your first API call to verify authentication:

bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
     http://YOUR_SERVER_IP/api/getinfo

Expected response: JSON object with all modem information.

Step 3: Rotate a Proxy

Rotate the IP address of a specific modem:

bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
     http://YOUR_SERVER_IP/api/change_ip?index=1

Step 4: Check Modem Status

Get information about all connected modems:

bash
curl -H "Authorization: Token YOUR_API_TOKEN" \
     http://YOUR_SERVER_IP/api/getinfo

Common Operations

Next Steps

Proxidize API Documentation