Basic Parameters
| Parameter | Description |
|---|---|
| Name | Optional parameter to filter devices by name. All returned devices will have a name that contains the search term or is an exact match. |
| Organization ID | Organization ID. Can be obtained via the List Organizations action. |
| Product Types | Optional parameter to filter devices by product type. Valid types are wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, and cloudGateway. |
Advanced Parameters
| Parameter | Description |
|---|---|
| Configuration Updated After | Filter results by whether or not the device’s configuration has been updated after the given timestamp. |
| Ending Before | A token used by the server to indicate the end of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| Mac | Optional parameter to filter devices by MAC address. All returned devices will have a MAC address that contains the search term or is an exact match. |
| Model | Optional parameter to filter devices by model. All returned devices will have a model that contains the search term or is an exact match. |
| Network ID | Optional parameter to filter devices by network. |
| Per Page | The number of entries per page returned. Acceptable range is 3 - 1000. Default is 1000. |
| Sensor Alert Profile IDs | Optional parameter to filter devices by the alert profiles that are bound to them. Only applies to sensor devices. |
| Sensor Metrics | Optional parameter to filter devices by the metrics that they provide. Only applies to sensor devices. |
| Serial | Optional parameter to filter devices by serial number. All returned devices will have a serial number that contains the search term or is an exact match. |
| Starting After | A token used by the server to indicate the start of the page. Often this is a timestamp or an ID but it is not limited to those. This parameter should not be defined by client applications. The link for the first, last, prev, or next page in the HTTP Link header should define it. |
| Tags | Optional parameter to filter devices by tags. |
| Tags Filter Type | Optional parameter of value ‘withAnyTags’ or ‘withAllTags’ to indicate whether to return networks which contain ANY or ALL of the included tags. If no type is included, ‘withAnyTags’ will be selected. |
Example Output
[
{
"address": "1600 Pennsylvania Ave",
"firmware": "wireless-25-14",
"lanIp": "1.2.3.4",
"lat": 37.4180951010362,
"lng": -122.098531723022,
"mac": "00:11:22:33:44:55",
"model": "MR34",
"name": "My AP",
"networkId": "N_24329156",
"notes": "My AP's note",
"productType": "wireless",
"serial": "Q234-ABCD-5678",
"tags": [
"recently-added"
]
}
]