List Locations

GET/api/v1/admin/proxy/locations

note

This endpoint requires Admin API Key authentication via the X-Admin-Key header.

Query Parameters

include_offlinebooleandefault: true

Include offline locations in the response

Response

locationsarray

Array of location objects

Location object

location_idstring

UUID of the location

location_codestring

Short code (e.g., "ua-odesa-1")

location_namestring

Human-readable name (e.g., "SpiderHub Odesa")

country_codestring

ISO 3166-1 alpha-2 country code

statusstring

Location status: online, offline, degraded

wireguard_ipstring

WireGuard VPN IP address

last_heartbeatstring

ISO 8601 timestamp of last agent heartbeat

modem_countinteger

Total number of modems at this location

online_modem_countinteger

Number of online modems

Request Example

curl -X GET "https://spideriq.ai/api/v1/admin/proxy/locations" \
  -H "X-Admin-Key: your_admin_key"

import requests

response = requests.get(
    "https://spideriq.ai/api/v1/admin/proxy/locations",
    headers={"X-Admin-Key": "your_admin_key"}
)
print(response.json())

Response Example

[
  {
    "location_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "location_code": "ua-odesa-1",
    "location_name": "SpiderHub Odesa",
    "country_code": "UA",
    "max_modems": 20,
    "wireguard_ip": "10.100.0.2",
    "status": "online",
    "last_heartbeat": "2025-01-15T12:30:00.000000",
    "modem_count": 4,
    "online_modem_count": 4,
    "created_at": "2025-01-01T10:00:00.000000",
    "updated_at": "2025-01-15T12:30:00.000000"
  }
]