Auvik icon

Auvik

Interact with Auvik API

Device → Get Many

AI-generated

Summary

Fetches a list of devices from Auvik, supporting filtering by tenant, device type, status, and date ranges.

Inputs

  • returnAll — If true, retrieves all matching devices regardless of limit. If false, use Limit to fetch a subset.
  • limit — Maximum number of devices to return. Only applies when Return All is false. Default is 100.
  • tenants — Select one or more tenants to query. If empty, queries across all tenants.
  • filterDeviceType — Filter devices by type (e.g., Access Point, Server, Firewall).
  • filterNetworks — Filter by IDs of networks this device is on.
  • filterVendorName — Filter by the device's vendor or manufacturer name.
  • filterMakeModel — Filter by the device's make and model.
  • filterDeviceName — Client-side filter to match device name (applied after API results are retrieved).
  • filterOnlineStatus — Filter by device's online status (e.g., Online, Offline, Dormant).
  • filterTrafficInsightsStatus — Filter by the device's TrafficInsights status (e.g., Approved, Forwarding, Linking).
  • modifiedAfterPreset — Quickly set the lower bound for modified time. Choose Custom to enter a specific datetime.
  • filterModifiedAfter — Lower bound of modified time (ISO 8601 UTC). Required when modifiedAfterPreset is Custom.
  • notSeenSincePreset — Quickly set the lower bound for last seen online time. Choose Custom to enter a specific datetime.
  • filterNotSeenSince — Lower bound of last seen online time (ISO 8601 UTC). Required when notSeenSincePreset is Custom.
  • filterStateKnown — Only devices with recently updated data are returned.
  • includeDeviceDetail — If true, includes the deviceDetail relationship in the response.
  • fieldsDeviceDetail — Select specific fields from the deviceDetail relationship (e.g., interfaces, components). Only applies when includeDeviceDetail is true.

Output shape

A list of items, each representing a device with its metadata.

The operation uses cursor-based pagination to retrieve all devices when Return All is enabled. Client-side filtering by device name is applied after the initial fetch.

Examples

Example 1: Retrieve all devices across all tenants regardless of type.

Return All: true, Tenants: empty, Filter Device Type: empty

Example 2: Get up to 50 devices from a specific tenant that are currently online.

Return All: false, Limit: 50, Tenants: [Tenant ID], Filter Online Status: Online

Example 3: Fetch all devices modified in the last 24 hours with interface details.

Return All: true, Modified After Preset: Last 24 hours, Include Device Detail: true, Fields Device Detail: interfaces

Links

Discussion