• What's Updated
  • [ networks ]
    • settings
      • Return the settings for a network
    • webhooks
      • Update an HTTP server
  • [ wireless ]
    • ssids
      • List the MR SSIDs in a network
      • Return a single MR SSID
      • Update the attributes of an MR SSID
  • [ organizations ]
    • devices
      • List the devices in an organization
• What's New
  • [ networks ]
    • devices
      • Claim a vMX into a network
  • [ organizations ]
    • summary
      • Return the top 10 appliances sorted by utilization over given time range.
      • Return metrics for organization's top 10 clients by data usage (in mb) over given time range.
      • Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.
      • Return metrics for organization's top 10 devices sorted by data usage over given time range. Default unit is megabytes.
      • Return metrics for organization's top 10 device models sorted by data usage over given time range. Default unit is megabytes.
      • Return metrics for organization's top 10 ssids by data usage over given time range. Default unit is megabytes.
      • Return metrics for organization's top 10 switches by energy usage over given time range. Default unit is joules.
  • [ devices ]
    • ping
      • Enqueue a job to ping a target host from the device
      • Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.
    • pingDevice
      • Enqueue a job to check connectivity status to the device
      • Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.

Version 1.13.0 to 1.14.0

Summary of Changes

12 - New

18 - Updated

496 - Total operations

313 - Total Paths

What's Updated

[ networks ]

settings

Return the settings for a network

GET /networks/{networkId}/settings

- Response property objectModule value added

webhooks

Update an HTTP server

PUT /networks/{networkId}/webhooks/httpServers/{httpServerId}

- Property url Read-only

[ wireless ]

ssids

List the MR SSIDs in a network

GET /networks/{networkId}/wireless/ssids

- Response property caCertificate value added

- Response property radiusAccountingServers value added

Return a single MR SSID

GET /networks/{networkId}/wireless/ssids/{number}

- Response property caCertificate value added

- Response property radiusAccountingServers value added

Update the attributes of an MR SSID

PUT /networks/{networkId}/wireless/ssids/{number}

- Optional property caCertificate Added

- Optional property caCertificate Added

[ organizations ]

devices

List the devices in an organization

GET /organizations/{organizationId}/devices

- Optional param productTypes added

- Optional param tags added

- Optional param tagsFilterType added

- Optional param name added

- Optional param mac added

- Optional param serial added

- Optional param model added

- Optional param sensorMetrics added

- Optional param sensorAlertProfileIds added

- Response property productType value added

What's New

[ networks ]

devices

PATH /networks/{networkId}/devices/claim/vmx

- Path added

- New operation

Claim a vMX into a network

POST /networks/{networkId}/devices/claim/vmx

{
    "name": "My AP",
    "lat": 37.4180951010362,
    "lng": -122.098531723022,
    "serial": "Q234-ABCD-5678",
    "mac": "00:11:22:33:44:55",
    "model": "VMX-S",
    "address": "1600 Pennsylvania Ave",
    "notes": "My AP's note",
    "lanIp": "1.2.3.4",
    "tags": [
        "recently-added"
    ],
    "networkId": "N_24329156",
    "beaconIdParams": {
        "uuid": "00000000-0000-0000-0000-000000000000",
        "major": 5,
        "minor": 3
    },
    "firmware": "wireless-25-14",
    "floorPlanId": "g_1234567"
}

---

[ organizations ]

summary

PATH /organizations/{organizationId}/summary/top/appliances/byUtilization

- Path added

- New operation

Return the top 10 appliances sorted by utilization over given time range.

GET /organizations/{organizationId}/summary/top/appliances/byUtilization

[
    {
        "network": {
            "name": "Main Office",
            "id": "N_24329156"
        },
        "name": "My appliance",
        "mac": "00:11:22:33:44:55",
        "serial": "Q234-ABCD-5678",
        "model": "MX",
        "utilization": {
            "average": {
                "percentage": 7.3
            }
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/clients/byUsage

- Path added

- New operation

Return metrics for organization's top 10 clients by data usage (in mb) over given time range.

GET /organizations/{organizationId}/summary/top/clients/byUsage

[
    {
        "name": "Office Switch",
        "mac": "22:33:44:55:66:77",
        "id": "k74272e",
        "network": {
            "name": "Main Office",
            "id": "N_24329156"
        },
        "usage": {
            "total": 18000,
            "upstream": 8000,
            "downstream": 10000,
            "percentage": 80.2
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage

- Path added

- New operation

Return metrics for organization's top clients by data usage (in mb) over given time range, grouped by manufacturer.

GET /organizations/{organizationId}/summary/top/clients/manufacturers/byUsage

[
    {
        "name": "Manufacturer Name",
        "clients": {
            "counts": {
                "total": 3
            }
        },
        "usage": {
            "total": 9000,
            "downstream": 8000,
            "upstream": 1000
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/devices/byUsage

- Path added

- New operation

Return metrics for organization's top 10 devices sorted by data usage over given time range. Default unit is megabytes.

GET /organizations/{organizationId}/summary/top/devices/byUsage

[
    {
        "name": "My AP",
        "model": "MR34",
        "serial": "Q234-ABCD-5678",
        "mac": "00:11:22:33:44:55",
        "productType": "switch",
        "network": {
            "name": "Main Office",
            "id": "N_24329156"
        },
        "usage": {
            "total": 18000,
            "percentage": 80.223456789
        },
        "clients": {
            "counts": {
                "total": 4
            }
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/devices/models/byUsage

- Path added

- New operation

Return metrics for organization's top 10 device models sorted by data usage over given time range. Default unit is megabytes.

GET /organizations/{organizationId}/summary/top/devices/models/byUsage

[
    {
        "model": "MR34",
        "count": 2,
        "usage": {
            "total": 2000,
            "average": 1000
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/ssids/byUsage

- Path added

- New operation

Return metrics for organization's top 10 ssids by data usage over given time range. Default unit is megabytes.

GET /organizations/{organizationId}/summary/top/ssids/byUsage

[
    {
        "name": "My SSID",
        "usage": {
            "total": 18000,
            "downstream": 10000,
            "upstream": 8000,
            "percentage": 80.223456789
        },
        "clients": {
            "counts": {
                "total": 4
            }
        }
    }
]

---

PATH /organizations/{organizationId}/summary/top/switches/byEnergyUsage

- Path added

- New operation

Return metrics for organization's top 10 switches by energy usage over given time range. Default unit is joules.

GET /organizations/{organizationId}/summary/top/switches/byEnergyUsage

[
    {
        "network": {
            "name": "Main Office",
            "id": "N_24329156"
        },
        "name": "My switch",
        "mac": "00:11:22:33:44:55",
        "model": "MS",
        "usage": {
            "total": 800.021
        }
    }
]

---

[ devices ]

ping

PATH /devices/{serial}/liveTools/ping

- Path added

- New operation

Enqueue a job to ping a target host from the device

POST /devices/{serial}/liveTools/ping

{
    "pingId": "1",
    "url": "/devices/SERIAL/liveTools/ping/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "75.75.75.75",
        "count": 2
    },
    "status": "complete",
    "results": {
        "sent": 5,
        "received": 5,
        "loss": {
            "percentage": 0
        },
        "latencies": {
            "minimum": 15.8,
            "average": 15.8,
            "maximum": 15.9
        },
        "replies": [
            {
                "sequenceId": 1,
                "size": 84,
                "latency": 15.7
            },
            {
                "sequenceId": 0,
                "size": 84,
                "latency": 15.9
            }
        ]
    }
}

---

PATH /devices/{serial}/liveTools/ping/{id}

- Path added

- New operation

Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.

GET /devices/{serial}/liveTools/ping/{id}

{
    "pingId": "1",
    "url": "/devices/SERIAL/liveTools/ping/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "75.75.75.75",
        "count": 2
    },
    "status": "complete",
    "results": {
        "sent": 5,
        "received": 5,
        "loss": {
            "percentage": 0
        },
        "latencies": {
            "minimum": 15.8,
            "average": 15.8,
            "maximum": 15.9
        },
        "replies": [
            {
                "sequenceId": 1,
                "size": 84,
                "latency": 15.7
            },
            {
                "sequenceId": 0,
                "size": 84,
                "latency": 15.9
            }
        ]
    }
}

---

pingDevice

PATH /devices/{serial}/liveTools/pingDevice

- Path added

- New operation

Enqueue a job to check connectivity status to the device

POST /devices/{serial}/liveTools/pingDevice

{
    "pingId": "1",
    "url": "/devices/SERIAL/liveTools/ping/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "75.75.75.75",
        "count": 2
    },
    "status": "complete",
    "results": {
        "sent": 5,
        "received": 5,
        "loss": {
            "percentage": 0
        },
        "latencies": {
            "minimum": 15.8,
            "average": 15.8,
            "maximum": 15.9
        },
        "replies": [
            {
                "sequenceId": 1,
                "size": 84,
                "latency": 15.7
            },
            {
                "sequenceId": 0,
                "size": 84,
                "latency": 15.9
            }
        ]
    }
}

---

PATH /devices/{serial}/liveTools/pingDevice/{id}

- Path added

- New operation

Return a ping job. Latency unit in response is in milliseconds. Size is in bytes.

GET /devices/{serial}/liveTools/pingDevice/{id}

{
    "pingId": "1",
    "url": "/devices/SERIAL/liveTools/ping/1284392014819",
    "request": {
        "serial": "Q234-ABCD-5678",
        "target": "75.75.75.75",
        "count": 2
    },
    "status": "complete",
    "results": {
        "sent": 5,
        "received": 5,
        "loss": {
            "percentage": 0
        },
        "latencies": {
            "minimum": 15.8,
            "average": 15.8,
            "maximum": 15.9
        },
        "replies": [
            {
                "sequenceId": 1,
                "size": 84,
                "latency": 15.7
            },
            {
                "sequenceId": 0,
                "size": 84,
                "latency": 15.9
            }
        ]
    }
}

---