Devices

Gateways, access points, and switches synced from your NMS integrations. Location fields (latitude, longitude, administrativeArea, locality) are resolved from the Starlink terminal serving the same site.

The device object

• projectNamestring

  The project or workspace name this device belongs to.

• siteCodestring

  Unique site identifier for the device.

• siteNamestring

  Human-readable site name.

• deviceNamestring

  Display name of the device.

• serialNumberstring | null

  Hardware serial number.

• ipAddressstring | null

  Last known IP address.

• macAddressstring | null

  MAC address.

• gatewayIdstring | null

  Serial number of the upstream gateway this device connects through. For a gateway row this is its own serial; for downstream access points and switches this is the nearest gateway in the uplink chain. Matches gatewayId on /v1/connected_clients.

• gatewayMacAddressstring | null

  MAC address of the upstream gateway.

• latitudefloat | null

  Device latitude coordinate.

• longitudefloat | null

  Device longitude coordinate.

• administrativeAreastring | null

  Province, state, or region.

• localitystring | null

  City or locality.

• uptimeinteger | null

  Current uptime in seconds.

• alertsstring | null

  Active alert codes from the device, if any.

---

List all devices GET /v1/devices

Returns devices accessible by your token, paginated.

Query parameters

• pageSizeinteger

  Number of records to return. Default 50, min 1, max 500.

• pageTokenstring

  Cursor from the previous response's pageInfo.nextPageToken. Omit for the first page.

• exclude_endedboolean

  Omits devices whose Starlink service line has ended (terminated subscriptions). Defaults to true. Pass exclude_ended=false to include them.

Pagination

The response includes a pageInfo object. Pass pageInfo.nextPageToken as pageToken in the next request to retrieve the following page. When hasNextPage is false you have reached the end.

GET/v1/devices

cURL

curl "https://polaris.revlv.com/v1/devices?pageSize=100" \
  -H "Authorization: Bearer {token}"

JavaScript

const res = await fetch('https://polaris.revlv.com/v1/devices?pageSize=100', {
  headers: { 'Authorization': 'Bearer {token}' },
});
const { data, pageInfo } = await res.json();

// Fetch next page
if (pageInfo.hasNextPage) {
  const next = await fetch(
    `https://polaris.revlv.com/v1/devices?pageToken=${pageInfo.nextPageToken}`,
    { headers: { 'Authorization': 'Bearer {token}' } },
  );
}

Go

req, _ := http.NewRequest("GET", "https://polaris.revlv.com/v1/devices?pageSize=100", nil)
req.Header.Add("Authorization", "Bearer {token}")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))

PHP

$response = $client->get('https://polaris.revlv.com/v1/devices', [
  'headers' => ['Authorization' => 'Bearer {token}'],
  'query'   => ['pageSize' => 100],
]);
echo $response->getBody();

Response

{
  "data": [
    {
      "projectName": "Main Fleet",
      "siteCode": "REV-001-001",
      "siteName": "Site A",
      "deviceName": "Site A Gateway",
      "serialNumber": "0000000000-00000000",
      "ipAddress": "192.168.1.1",
      "macAddress": "aa:bb:cc:dd:ee:ff",
      "gatewayId": "0000000000-00000000",
      "gatewayMacAddress": "aa:bb:cc:dd:ee:ff",
      "latitude": 10.5924,
      "longitude": 122.6904,
      "administrativeArea": "Iloilo",
      "locality": "San Lorenzo",
      "uptime": 86400,
      "alerts": null
    }
  ],
  "pageInfo": {
    "hasNextPage": true,
    "nextPageToken": "ZjQ3YWMxMGItNThjYy00MzcyLWE1NjctMGUwMmIyYzNkNDc5"
  }
}