> ## Documentation Index
> Fetch the complete documentation index at: https://docs.stackone.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Auvik

> How to set up the Auvik connector, plus the actions and events that are available.

![Auvik](https://stackone-logos.com/api/auvik/filled/svg)

v1.2.0[See changelog](https://docs.stackone.com/connectors/auvik/changelog.md)

[50 actions](#actions) · [1 event](#events) · 1 auth method

Observability

## Getting Started

**1. Create or Select a Project**

Set up a new project or select an existing one. See [Organizations & Projects](https://docs.stackone.com/gateway/concepts/organizations-and-projects.md).

**2. Configure the Connector**

Enable the connector and create a Connector Profile in your project. See [Setup Connector Profile](https://docs.stackone.com/gateway/quickstart.md#setup-connector-profile).

> [card] [Basic Auth · Connector Profile](https://docs.stackone.com/connectors/auvik/guides/connector-profile/basic-auth.md)
>
> Authenticate with your Auvik account username and that user's API key as the password. The user must have the role permi...

Optionally, configure receiving Events for Auvik into StackOne.

> [card] [Webhooks setup](https://docs.stackone.com/connectors/auvik/guides/webhook-setup.md)

**3. Link an Account**

Link an account [from the dashboard](https://docs.stackone.com/connect/managing-connectors/linking-accounts.md#link-from-the-dashboard) (or via [StackOne Hub](https://docs.stackone.com/embed/account-linking/overview)).

See the guide for the authentication type chosen in the Connector Profile:

> [card] [Basic Auth · Link Account](https://docs.stackone.com/connectors/auvik/guides/link-account/basic-auth.md)

**4. Use Actions**

Connect an AI platform to the linked account's actions. See [AI Platforms](https://docs.stackone.com/ai-platforms/overview.md).

Other ways to call actions are listed in [Protocols & SDKs](https://docs.stackone.com/connect/protocols-and-sdks.md).

## Actions

50 actions

ActionDescription

Read Multiple Devices' Info`auvik_list_devices_info`

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

Read A Single Device's Info`auvik_get_device_info`

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

Read Multiple Devices' Details`auvik_list_devices_details`

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

Read A Single Device's Details`auvik_get_device_details`

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

Read Multiple Devices' Extended Details`auvik_list_devices_extended_details`

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

Read A Single Device's Extended Details`auvik_get_device_extended_details`

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

Read Multiple Devices' Lifecycle Info`auvik_list_device_lifecycle`

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

Read A Single Device's Lifecycle Info`auvik_get_device_lifecycle`

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

Read Multiple Devices' Warranty Info`auvik_list_device_warranty`

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

Read A Single Device's Warranty Info`auvik_get_device_warranty`

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

Read Multiple Networks' Info`auvik_list_networks_info`

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

Read A Single Network's Info`auvik_get_network_info`

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

Read Multiple Networks' Details`auvik_list_networks_details`

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

Read A Single Network's Details`auvik_get_network_details`

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

Read Multiple Interfaces' Info`auvik_list_interfaces_info`

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

Read A Single Interface's Info`auvik_get_interface_info`

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

Read Multiple Components' Info`auvik_list_components_info`

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

Read A Single Component's Info`auvik_get_component_info`

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

Read Multiple Device Configurations`auvik_list_configurations`

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

Read A Single Device Configuration`auvik_get_configuration`

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

Read Multiple Entity Audits`auvik_list_entity_audits`

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

Read A Single Entity Audit`auvik_get_entity_audit`

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

Read Multiple Entity Notes`auvik_list_entity_notes`

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

Read A Single Entity Note`auvik_get_entity_note`

Retrieve a single entity note by its unique note ID.

Read Multiple Tenants`auvik_list_tenants`

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

Read Multiple Tenant Details`auvik_list_tenants_detail`

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

Read A Single Tenant Detail`auvik_get_tenant_detail`

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

Read Multiple Alerts' Info`auvik_list_alerts`

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

Read A Single Alert's Info`auvik_get_alert`

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

Dismiss An Alert`auvik_dismiss_alert`

Dismiss an active alert by its unique alert ID.

Read Device Statistics`auvik_read_device_statistics`

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

Read Device Availability Statistics`auvik_read_device_availability_statistics`

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

Read Interface Statistics`auvik_read_interface_statistics`

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

Read Component Statistics`auvik_read_component_statistics`

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

Read OID Statistics`auvik_read_oid_statistics`

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

Read Service Statistics`auvik_read_service_statistics`

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

Read SNMP Poller Integer Statistics`auvik_read_snmp_poller_int_statistics`

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

Read SNMP Poller String Statistics`auvik_read_snmp_poller_string_statistics`

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

Read Multiple SNMP Poller Settings`auvik_list_snmp_poller_settings`

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

Read A Single SNMP Poller Setting`auvik_get_snmp_poller_setting`

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

Read Devices For An SNMP Poller Setting`auvik_list_snmp_poller_setting_devices`

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

Read Client Billing Usage`auvik_read_client_billing_usage`

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

Read Device Billing Usage`auvik_read_device_billing_usage`

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

Read Multiple ASM Clients`auvik_list_asm_clients`

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

Read Multiple ASM Users`auvik_list_asm_users`

Retrieve the SaaS users discovered for a given ASM client.

Read Multiple ASM Applications`auvik_list_asm_apps`

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

Read Multiple ASM Licenses`auvik_list_asm_licenses`

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

Read Multiple ASM Tags`auvik_list_asm_tags`

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

Read Multiple ASM Security Logs`auvik_list_asm_security_logs`

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

Verify API Credentials`auvik_verify_credentials`

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

## Events

Tags

Select all
|
Clear

Alerts

Webhooks

No tags found

1 event

EventDescriptionTags

Alert Webhook`auvik_webhook_alert`

Processes every Auvik alert notification delivered to the webhook notification channel, both when an alert is triggered...

AlertsWebhooks


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.