networks-list-clients
Retrieve a filtered list of clients that have used a specific network within a given timespan. Supports filtering by status, IP, MAC, OS, VLAN, and more.
Instructions
List the clients that have used this network in the timespan. (read-only)
Input Schema
TableJSON Schema
| Name | Required | Description | Default |
|---|---|---|---|
| networkId | Yes | Network ID | |
| t0 | No | The beginning of the timespan for the data. The maximum lookback period is 31 days from today. | |
| timespan | No | The timespan for which the information will be fetched. If specifying timespan, do not specify parameter t0. The value must be in seconds an | |
| perPage | No | The number of entries per page returned. Acceptable range is 3 - 5000. Default is 10. | |
| startingAfter | No | 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 parame | |
| endingBefore | No | 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 paramete | |
| statuses | No | Filters clients based on status. Can be one of 'Online' or 'Offline'. | |
| ip | No | Filters clients based on a partial or full match for the ip address field. | |
| ip6 | No | Filters clients based on a partial or full match for the ip6 address field. | |
| ip6Local | No | Filters clients based on a partial or full match for the ip6Local address field. | |
| mac | No | Filters clients based on a partial or full match for the mac address field. | |
| os | No | Filters clients based on a partial or full match for the os (operating system) field. | |
| pskGroup | No | Filters clients based on partial or full match for the iPSK name field. | |
| description | No | Filters clients based on a partial or full match for the description field. | |
| vlan | No | Filters clients based on the full match for the VLAN field. | |
| namedVlan | No | Filters clients based on the partial or full match for the named VLAN field. | |
| recentDeviceConnections | No | Filters clients based on recent connection type. Can be one of 'Wired' or 'Wireless'. | |
| fields | No | Return only these top-level fields; omit for all. Available: adaptivePolicyGroup, description, deviceTypePrediction, firstSeen, groupPolicy8021x, id, ip, ip6, ip6Local, lastSeen, mac, manufacturer, namedVlan, notes, os, pskGroup, recentDeviceConnection, recentDeviceMac, recentDeviceName, recentDeviceSerial, smInstalled, ssid, status, switchport, usage, user, vlan, wirelessCapabilities. |