Skip to content

SOP-002: Get Modem Information

Fresh
FieldValue
Document IDSOP-002
Version1.0
StatusActive
Plan RequiredEssential+

Overview

Retrieve detailed information about all connected modems including IP addresses, signal strength, and connection status.

Prerequisites

  • Valid API token (SOP-001)
  • Proxidize Essential, Plus, or Business plan

Procedure

API Endpoint

GET /api/getinfo

Request Example

cURL:

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

JavaScript:

javascript
const response = await fetch('http://YOUR_SERVER_IP/api/getinfo', {
  headers: { 'Authorization': 'Token YOUR_API_TOKEN' }
});
const modems = await response.json();
console.log(modems);

Response Format

The API returns a JSON object containing information for each modem:

json
{
  "modems": [
    {
      "index": 1,
      "ip": "192.168.1.101",
      "public_ip": "203.0.113.45",
      "signal": "excellent",
      "carrier": "Verizon",
      "status": "connected",
      "phone_number": "+15551234567"
    },
    {
      "index": 2,
      "ip": "192.168.1.102",
      "public_ip": "203.0.113.46",
      "signal": "good",
      "carrier": "AT&T",
      "status": "connected",
      "phone_number": "+15559876543"
    }
  ]
}

Response Fields

FieldDescription
indexModem index number (used in other API calls)
ipPrivate IP address
public_ipPublic IP address
signalSignal strength (excellent/good/fair/poor)
carrierMobile carrier name
statusConnection status
phone_numberSIM card phone number

Verification Checklist

  • [ ] Request returns HTTP 200
  • [ ] Response is valid JSON
  • [ ] Modem count matches physical devices
  • [ ] All modems show correct status

Troubleshooting

IssueCauseSolution
Empty responseNo modems connectedCheck USB connections
Missing modemModem not detectedReboot modem or check drivers
Stale IP dataCached responseWait and retry request

See Also

Proxidize API Documentation