Auvik icon

Auvik

Interact with Auvik API

Component → Get Many

AI-generated

Summary

Retrieves a list of components from Auvik with filtering options for tenants, status, device IDs, names, and modification dates.

Inputs

  • returnAll (required) — Whether to retrieve all components or limit the results. If false, the Limit parameter is used.
  • limit — Maximum number of components to return per page. Applicable when returnAll is false. Range: 1-10000.
  • tenants — Select specific tenants to filter components by. Uses the 'getTenants' load options method.
  • modifiedAfterPreset — Quickly set a lower bound for the component's modified time using a preset (e.g., Last 24 hours, Today). Choose 'Custom' to enter a specific ISO 8601 datetime.
  • filterModifiedAfter — Lower bound for the component's modified time in ISO 8601 UTC format. Visible only when modifiedAfterPreset is set to 'Custom'.
  • filterDeviceId — Filter components by a specific device ID.
  • filterDeviceName — Filter components by a specific device name.
  • filterCurrentStatus — Filter components by current status (e.g., OK, Failed, Degraded).

Output shape

a list of items, each representing a component

Returns a list of components. Uses cursor-based pagination (via helpers/pagination.js) when returnAll is true.

Examples

Example 1: Get all components modified in the last 7 days for all tenants

returnAll: true, modifiedAfterPreset: 'LAST_7_DAYS'

Example 2: Retrieve up to 50 components for a specific tenant with a degraded status

returnAll: false, limit: 50, tenants: [Tenant ID], filterCurrentStatus: 'degraded'

Example 3: Get components from a specific device modified after a custom date

returnAll: false, limit: 100, filterDeviceName: 'Router-01', modifiedAfterPreset: 'CUSTOM', filterModifiedAfter: '2023-01-01T00:00:00.000Z'

Links

Discussion