Auvik

Retrieve a paginated list of monitored devices with their summary inventory info, optionally scoped to specific tenants…

Retrieve the summary inventory info for a single device by its unique device ID.

Retrieve a paginated list of devices with their detailed discovery and management attributes, optionally scoped to tenan…

Retrieve the detailed discovery and management attributes for a single device by its unique device ID.

Retrieve a paginated list of devices with their extended details for a required device type, optionally scoped to tenant…

Retrieve the extended details for a single device by its unique device ID.

Retrieve a paginated list of devices with their lifecycle status (sales availability, software/security maintenance, las…

Retrieve the lifecycle status (sales availability, software/security maintenance, last support) for a single device by i…

Retrieve a paginated list of devices with their warranty coverage info, optionally scoped to tenants and filtered by cov…

Retrieve the warranty coverage info for a single device by its unique device ID.

Retrieve a paginated list of discovered networks with their summary info, optionally scoped to tenants and filtered by n…

Retrieve the summary info for a single network by its unique network ID.

Retrieve a paginated list of networks with their detailed attributes, optionally scoped to tenants and filtered by netwo…

Retrieve the detailed attributes for a single network by its unique network ID.

Retrieve a paginated list of device interfaces with their summary info, optionally scoped to tenants and filtered by int…

Retrieve the summary info for a single interface by its unique interface ID.

Retrieve a paginated list of hardware components (fans, power supplies, sensors, etc.) with their summary info, optional…

Retrieve the summary info for a single hardware component by its unique component ID.

Retrieve a paginated list of backed-up device configurations, optionally scoped to tenants and filtered by device, backu…

Retrieve a single backed-up device configuration by its unique configuration ID.

Retrieve a paginated list of entity audit records (remote access sessions and similar activities), optionally scoped to…

Retrieve a single entity audit record by its unique audit ID.

Retrieve a paginated list of notes attached to entities, optionally scoped to tenants and filtered by entity, type, name…

Retrieve a single entity note by its unique note ID.

Retrieve the list of client tenants accessible to the authenticated API user.

Retrieve detailed information for the client tenants under a given primary (parent) tenant domain prefix.

Retrieve detailed information for a single tenant by its unique tenant ID, within a given primary tenant domain prefix.

Retrieve a paginated list of alert history records, optionally scoped to tenants and filtered by alert definition, sever…

Retrieve a single alert history record by its unique alert ID.

Dismiss an active alert by its unique alert ID.

Read time-series device performance statistics (bandwidth, CPU, memory, storage utilization, packet counters) for a give…

Read time-series device availability statistics (availability, outage time, downtime) for a given statistic type over a…

Read time-series interface performance statistics (bandwidth, utilization, packet counters) for a given statistic type o…

Read time-series component statistics (temperature, fan speed, power status) for a given component type and statistic ty…

Read SNMP OID monitor statistics, optionally filtered by device and OID and scoped to tenants.

Read time-series cloud service ping statistics (round-trip time, packet loss, packets transmitted/received) for a given…

Read time-series integer values collected by custom SNMP pollers over a time range, scoped to tenants and optionally fil…

Read time-series string values collected by custom SNMP pollers over a time range, scoped to tenants and optionally filt…

Retrieve a paginated list of custom SNMP poller settings for given tenants, optionally filtered by device, name, OID, ty…

Retrieve a single custom SNMP poller setting by its unique poller setting ID.

Retrieve a paginated list of devices that a given SNMP poller setting applies to for given tenants, optionally filtered…

Read billable usage for client tenants over a given date range, optionally scoped to specific tenants.

Read billable usage for a single device over a given date range.

Retrieve the list of Auvik SaaS Management (ASM) clients accessible to the authenticated API user.

Retrieve the SaaS users discovered for a given ASM client.

Retrieve the SaaS applications discovered for a given ASM client, optionally with breach, user, contract, publisher, and…

Retrieve the SaaS license assignments for a given ASM client and application, with optional under-utilization and last-l…

Retrieve the SaaS application tags for a given ASM client, optionally scoped to a single application.

Retrieve the SaaS security log events for a given ASM client, optionally with related users and applications.

Verify that the configured Auvik API credentials (username and API key) are valid.