Pingboxes

List pingboxes

Your pingboxes: the vantage points inside your network that ping your devices and run live tests. Each device is pinged from one pingbox (get_device shows which, and list_devices can filter by it), and the network default covers devices with no other assignment. A pingbox's hardware is the box it runs on. status is online, offline, or no_hardware (nothing is running it, so its devices aren't being pinged); more states may be added.

Parameters

• isp string query

  ISP code from GET /isps. Optional when the key reaches exactly one ISP.

• limit integer query

  Max rows (default 200, max 500)

• cursor string query

  next_cursor from the previous page

Response

Also available as CSV: add format=csv. Columns follow the field order below, with nested fields as dotted columns (ap.name).

Paged: pass next_cursor back as cursor for the next page.

• count integer
• next_cursor string nullable

  Pass as cursor to get the next page; null on the last page

• pingboxes array of objects
  Each item: 6 fields

  • pingboxid integer

    Pass as pingboxid to ping and traceroute, or as pingbox to list_devices

  • name string
  • is_default boolean

    The network default: devices with no other assignment are pinged from it

  • status string

    online, offline or no_hardware; more states may be added

  • hardware object nullable

    The box this pingbox runs on; null when it has none

    1 fields

    • kind string

      cloud, vm, on_prem, pathbox, container or unknown; more kinds may be added

  • device_count integer

    Infrastructure devices pinged from it. CPEs are pinged from their AP's pingbox

Example

curl -H "Authorization: Bearer $SWIFTFOX_KEY" \
  "https://api.swiftfox.net/v1/pingboxes?isp=yourisp"

Response (example data):

{
  "count": 3,
  "next_cursor": null,
  "pingboxes": [
    {
      "pingboxid": 0,
      "name": "Riverbend Cloud",
      "is_default": true,
      "status": "online",
      "hardware": {
        "kind": "cloud"
      },
      "device_count": 41
    },
    {
      "pingboxid": 1,
      "name": "Hilltop",
      "is_default": false,
      "status": "online",
      "hardware": {
        "kind": "on_prem"
      },
      "device_count": 18
    },
    {
      "pingboxid": 2,
      "name": "Mill Valley",
      "is_default": false,
      "status": "no_hardware",
      "hardware": null,
      "device_count": 0
    }
  ]
}