Auvik actions & endpoints
Become familiar with the actions available to use with your Auvik integration
Last updated
Was this helpful?
Become familiar with the actions available to use with your Auvik integration
Last updated
Was this helpful?
The Auvik Integration with Rewst delivers a robust set of actions and endpoints for interacting with Auvik networks and devices. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Auvik Integration:
: Manage and retrieve alert information.
: Access details of device components.
: Handle device configurations.
: Explore details, warranties, and lifecycle information of devices.
: Retrieve notes and audits of discovered entities.
: List and fetch information about device interfaces.
: Access networks and specific network details.
: Retrieve SNMP Poller settings, devices, and history.
: Obtain statistics for devices, interfaces, components, and OIDs.
: Manage tenant details, including listing and specific information retrieval.
: Retrieve summaries of client and device usage.
The Alerts section encompasses three endpoints, providing capabilities to list alerts, retrieve specific alert information, and dismiss an alert. These functionalities enable you to stay informed and in control of your system's notifications, empowering you to manage alerts triggered by your Auvik collector(s) effectively.
In the Components section, two specific endpoints enable you to access detailed information about device components discovered by Auvik. Whether you need to view multiple components or retrieve details about a specific component associated with a client device, this section provides the necessary tools to manage and understand your device components.
The Configurations section of the Auvik Integration provides endpoints to view details about device configurations discovered by Auvik. With specific endpoints for multiple and single device configurations, you can gain a thorough understanding of the device configuration history associated with your Auvik user account, ensuring optimal device management.
The Devices section of the Auvik Integration offers an extensive suite of endpoints that allow you to access information about individual and multiple devices discovered by Auvik. This includes details, extended details, warranty information, and lifecycle data. These endpoints provide a granular view of the devices, enabling effective management and oversight.
The Entities section of the Auvik Integration provides insights into notes and audit trails associated with the entities (devices, networks, and interfaces) discovered by Auvik. With specific endpoints for multiple entity audits and notes, as well as individual entity audit and note retrieval, this section offers detailed information about your client entities, enhancing your understanding and control.
In the Interfaces section, two specific endpoints provide detailed information about device interfaces discovered by Auvik. Whether you need information about multiple interfaces or specific details about an individual interface, this section allows for comprehensive interface management.
The Networks section enables users to view and manage details about networks discovered by Auvik. With specific endpoints for individual and multiple networks, you can access both the general overview of networks and specific details, enhancing your control over network management.
The SNMP Poller & History section offers a set of endpoints to view and manage SNMP Poller Settings within Auvik. This includes details about multiple settings, specific SNMP Poller Settings, and historical values. It's designed to provide a comprehensive view of SNMP Polling configurations and their historical data.
The Statistics section of the Auvik Integration provides six endpoints for viewing various entity statistics monitored by Auvik. This includes device statistics, availability statistics, service statistics, interface statistics, component statistics, and OID statistics. These endpoints offer insights into historical and current statistics, enhancing monitoring capabilities.
With three endpoints, the Tenants section of the Auvik Integration enables users to view and manage access details to multi-clients or clients associated with an Auvik user account. It provides insights into permissions and detailed information about multiple tenants and individual tenant details.
The Usage section of the Auvik Integration, comprising two endpoints, allows users to view usage data that informs invoice calculations. Whether you need to access client usage or device usage, this section provides detailed insights into consumption over specified time ranges.
Use the Read Multiple Alerts’ Info API to pull the collected information about the various alerts that Auvik has triggered. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by alert definition ID.
MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAoFilter by alert specification ID. Use 'alertDefinitionId' instead
-100Filter by alert severity.
warningAvailable options: Filter by the status of the alert.
createdAvailable options: Filter by the related entity ID.
MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOAFilter by the dismissed status.
falseFilter by dispatched status.
falseFilter by the time which is greater than the given timestamp.
2018-11-21T20:56:38.922ZFilter by the time which is less than or equal to the given timestamp.
2018-11-30T18:34:42.652ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Alert’s Info API to pull the collected information about a specific alert that Auvik has triggered. To find the alert IDs, run the Read Multiple Alerts API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of alert
Root level object per the json-api spec
Use the Read Multiple Components’ Info API to pull collected information about various device components Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZFilter by the component’s parent device’s ID.
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by the component’s parent device’s name.
"ESXi-H153.MSC.MGMT"Filter by the component’s current status.
okAvailable options: Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Component’s Info API to pull collected information about a specific device component Auvik has discovered. You’ll need the component ID you want audit detail for. To find the component IDs, run the Read Multiple Components’ Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of component
Root level object per the json-api spec
Use the Read Multiple Device Configuration API to pull all device configurations. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by date and time, filtering out configurations backed up before value.
2018-03-12T12:00:00.000ZFilter by date and time, filtering out configurations backed up after value.
2018-03-12T12:00:00.000ZFilter for configurations that are currently running, or filter for all configurations which are not currently running.
trueComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Device Configuration API to pull a single device configuration. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of configuration
Root level object per the json-api spec
Use the Read Single Device’s Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Use to include the full resource objects of the list device relationships.
deviceDetailAvailable options: Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=deviceDetail
discoveryStatus,componentsAvailable options: Root level object per the json-api spec
Use the Read Single Device’s Details API to pull extra collected information about a specific device Auvik has discovered not already included in the Device Info API. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Root level object per the json-api spec
Use the Read Single Device’s Extended Details API to get a device’s extended details. Many device types have information collected and tracked by Auvik that are unique to that device type. Use this endpoint to access such information for a given device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Root level object per the json-api spec
Use the Read Single Device’s Warranty Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Root level object per the json-api spec
Use the Read Single Device’s Lifecycle Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Root level object per the json-api spec
Use the Read Multiple Devices’ Info API to pull the collected information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by IDs of networks this device is on.
MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMwFilter by device type.
accessPointAvailable options: Filter by the device’s make and model.
"M Series Access Point"Filter by the device’s vendor/manufacturer.
UbiquitiFilter by the device’s online status.
onlineAvailable options: Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZFilter by the last seen online time, returning entities not seen online after the provided value.
2018-11-30T18:34:42.652ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Use to include the full resource objects of the list device relationships.
deviceDetailAvailable options: Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=deviceDetail
discoveryStatus,componentsAvailable options: Root level object per the json-api spec
Use the Read Multiple Devices’ Details API to pull extra collected information about the various devices Auvik has discovered not already included in the Device Info API. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by managed status
trueFilter by the device’s SNMP discovery status.
disabledAvailable options: Filter by the device’s WMI discovery status.
disabledAvailable options: Filter by the device’s Login discovery status.
disabledAvailable options: Filter by the device’s VMware discovery status.
disabledAvailable options: Filter by the device’s TrafficInsights status.
approvedAvailable options: Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple Devices’ Extended Details API to get many devices’ extended details. Many device types have information collected and tracked by Auvik that are unique to that device type. Use this endpoint to access such information for a given device. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by device type.
accessPointAvailable options: Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZFilter by the last seen online time, returning entities not seen online after the provided value.
2018-11-30T18:34:42.652ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple Devices’ Warranty API to pull the collected warranty information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by warranty coverage status.
trueFilter by service coverage status.
trueComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple Devices’ Lifecycle API to pull the collected lifecycle information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by sales availability.
availableAvailable options: Filter by software maintenance status.
availableAvailable options: Filter by security software maintenance status.
availableAvailable options: Filter by last support status.
availableAvailable options: Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Entity Note API to pull the information about a specific entity note. You’ll need the entity note ID for the specific entity note. To find the note IDs the Read Multiple Entity Notes API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of entity note
Root level object per the json-api spec
Use the Single Multiple Entity Audit API pull information about a single entity audit. You’ll need the audit entry ID for the specific audit. To find the audit ID, run the Read Multiple Entity Audits API Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of entity audit
Root level object per the json-api spec
Use the Read Multiple Entity Notes API pull information about multiple entity notes. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by the entity’s ID.
MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMwFilter by the entity’s type.
networkAvailable options: Filter by the entity’s name.
"192.168.4.0/24"Filter by the user the note was last modified by.
"John User"Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple Entity Audits API pull information about multiple entity audits for you clients. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by user name associated to the audit.
"John Smith"Filter by the audit’s category.
unknownAvailable options: Filter by the audit’s status.
createdAvailable options: Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Interface Info API to pull the collected information about a specific device interface Auvik has discovered. You’ll need the interface ID for the specific interface. To find the interface IDs, run the Read Multiple Interfaces Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of interface
Root level object per the json-api spec
Use the Read Multiple Interfaces Info API to pull the collected information about the various device interfaces Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by interface type.
ethernetAvailable options: Filter by the entity's parent device ID.
MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNAFilter by the interface’s admin status.
trueFilter by the interface’s operational status.
onlineAvailable options: Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single Network’s Info API to pull the collected information about a specific network Auvik has discovered. You’ll need the network ID for the specific network. To find the network IDs, run the Read Multiple Networks’ Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of network
Use to include the full resource objects of any of the network’s relationships.
networkDetailAvailable options: Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=networkDetail
scope,excludedIpAddressesAvailable options: Root level object per the json-api spec
Use the Read Multiple Networks’ Info API to pull the collected information about the various networks Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by network type.
routedAvailable options: Filter by the network’s scan status.
trueAvailable options: Filter by IDs of devices on this network. Filter by multiple values by providing a comma delimited list.
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Use to include the full resource objects of any of the network’s relationships.
networkDetailAvailable options: Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=networkDetail
scope,excludedIpAddressesAvailable options: Root level object per the json-api spec
Use the Read Single Networks’s Details API to pull extra collected information about a specific network Auvik has discovered not already included in the network Info API. You’ll need the network ID for the specific network. To find the network IDs, run the Read Multiple Networks API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of network
Root level object per the json-api spec
Use the Read Multiple Networks’ Details API to pull extra collected information about the various networks Auvik has discovered not already included in the Network Info API. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Filter by network type.
routedAvailable options: Filter by the network’s scan status.
trueAvailable options: Filter by IDs of devices on this network. Filter by multiple values by providing a comma delimited list.
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZFilter by the network’s scope
privateAvailable options: Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple SNMP Poller Settings API to pull the list of SNMP Poller Settings configured in Auvik. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by oid type
pollerAvailable options: Filter by device type.
accessPointAvailable options: Filter by the device’s make and model.
M%22Series%20Access%20PointM%22Filter by the device’s vendor/manufacturer.
UbiquitiFilter by OID
1.3.6.1.2.1.1.3Filter by the name of the SNMP poller setting
M%22SteveM%22For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Single SNMP Poller Setting API to pull details of a specific SNMP Poller Setting configured in Auvik. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of the SNMP Poller Setting to retrieve
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwRoot level object per the json-api spec
Use Read SNMP Poller Setting's Devices API to pull the list of devices that apply to a specific SNMP Poller Setting Id. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of the SNMP Poller Setting that the devices apply to
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004Filter by the device’s online status.
onlineAvailable options: Filter by date and time, only returning entities modified after provided value.
2018-03-12T12:00:00.000ZFilter by the last seen online time, returning entities not seen online after the provided value.
2018-11-30T18:34:42.652ZFilter by device type.
accessPointAvailable options: Filter by the device’s make and model.
"M Series Access Point"Filter by the device’s vendor/manufacturer.
UbiquitiFor paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Timestamp from which you want to query
2022-03-10 01:00:00Timestamp to which you want to query (defaults to current time)
2022-03-10 09:00:00Whether to show compact view of the results or not. Compact view only shows changes in value. If compact view is false, dateTime range can be a maximum of 24h
trueComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwComma delimited list of SNMP poller setting IDs to request info from. Note this is internal snmpPollerSettingId. The user can get the list of IDs for a specific poller using the GET /settings/snmppoller endpoint.
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE,Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5RFor paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Timestamp from which you want to query
2022-03-10 01:00:00Timestamp to which you want to query (defaults to current time)
2022-03-10 09:00:00Statistics reporting interval
hourAvailable options: Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwComma delimited list of SNMP poller setting IDs to request info from. Note this is internal snmpPollerSettingId. The user can get the list of IDs for a specific poller using the GET /settings/snmppoller endpoint.
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE,Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5RFor paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Device Statistics API to fetch detailed statistics of a client’s (and client’s children if a multi-client) devices for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of statistic to return
Timestamp from which you want to query
2020-03-10T01:00:00.000ZTimestamp to which you want to query (defaults to current time)
2020-03-11T01:00:00.000ZStatistics reporting interval
hourAvailable options: Filter by device type.
accessPointAvailable options: Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Device Availability Statistics API to fetch detailed availability statistics of a client’s (and client’s children if a multi-client) devices for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of statistic to return
Timestamp from which you want to query
2020-03-10T01:00:00.000ZTimestamp to which you want to query (defaults to current time)
2020-03-11T01:00:00.000ZStatistics reporting interval
hourAvailable options: Filter by device type.
accessPointAvailable options: Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Service Statistics API to fetch detailed statistics of a client’s (and client’s children if a multi-client) services for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of statistic to return
Timestamp from which you want to query
2020-03-10T01:00:00.000ZTimestamp to which you want to query (defaults to current time)
2020-03-11T01:00:00.000ZStatistics reporting interval
hourAvailable options: Filter by service ID
NzkyMywtMjAwMDAwMCxzdGF0L3NlcnZpY2UvcGluZ1RpbWU6aG91cgComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Interface Statistics API to fetch detailed statistics of a client's (and client's children if a multi-client) interfaces for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of statistic to return
Timestamp from which you want to query
2020-03-10T01:00:00.000ZTimestamp to which you want to query (defaults to current time)
2020-03-11T01:00:00.000ZStatistics reporting interval
hourAvailable options: Filter by interface type.
ethernetAvailable options: Filter by interface ID.
MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OAFilter by the entity's parent device ID.
MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNAComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Component Statistics API to fetch detailed statistics of a client's (and client's children if a multi-client) components for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Component type of statistic to return
ID of statistic to return
Timestamp from which you want to query
2020-03-10T01:00:00.000ZTimestamp to which you want to query (defaults to current time)
2020-03-11T01:00:00.000ZStatistics reporting interval
hourAvailable options: Filter by component ID.
MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OAFilter by the entity's parent device ID.
MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNAComma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read OID Statistics API to fetch the last recorded value of a monitored device OID. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of statistic to return
Filter by device ID
MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2NwFilter by device type.
accessPointAvailable options: Filter by OID
1.3.6.1.2.1.1.3Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004For paginated responses, the first N elements will be returned. Used in combination with page[after].
100Example: 100Cursor after which elements will be returned as a page. The page size is provided by page[first].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100For paginated responses, the last N services will be returned. Used in combination with page[before].
100Example: 100Cursor before which elements will be returned as a page. The page size is provided by page[last].
Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100Root level object per the json-api spec
Use the Read Multiple Tenants API to pull access detail about multiple multi-clients and clients associated with your Auvik user account. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. user@example.com should be the email address of a user with permissions to view tenant information. apiKey should be the API key that’s been set for the user.
root level object per the json-api spec
Use the Read a Single Tenant API to pull detail about a specific multi-client and client associated with your main Auvik account. You’ll need the tenant ID for the specific multi-client or client you want detail for. You can find the tenant ID for the multi-client or client by Read Multiple Tenants Detail. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. user@example.com should be the email address of a user with permissions to edit Client Management. apiKey should be the API key that’s been set for the user. 322018492519875477 should be the tenant ID. mspdemo should be the domain prefix of your main Auvik account. To locate your domain prefix, log into your Auvik dashboard and look at the URL in your browser’s address bar.
ID of tenant
Domain prefix of your main Auvik account (tenant).
mspdemoroot level object per the json-api spec
Use the Read Multiple Tenants API to pull details for multiple multi-clients and clients associated with your main Auvik account. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. user@example.com should be the email address of a user with permissions to view tenant information. apiKey should be the API key that’s been set for the user. mspdemo should be the domain prefix of your main Auvik account. To locate your domain prefix, log into your Auvik dashboard and look at the URL in your browser’s address bar.
Domain prefix of your main Auvik account (tenant).
mspdemoFilter whether or not a tenant is available, i.e. data can be gotten from them via the API.
trueroot level object per the json-api spec
Use the Read Device Usage API to pull a summary of a client’s (and client’s children if a multi-client) usage for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
ID of device
Date from which you want to query
2019-06-01Pattern: 20[0-9]{2}-[01][0-9]-[0123][0-9]Date to which you want to query
2019-06-30Pattern: 20[0-9]{2}-[01][0-9]-[0123][0-9]Root level object per the json-api spec
Use the Read Client Usage API to pull a summary of a client’s (and client’s children if a multi-client) usage for a given time range. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:
Date from which you want to query
2019-06-01Pattern: 20[0-9]{2}-[01][0-9]-[0123][0-9]Date to which you want to query
2019-06-30Pattern: 20[0-9]{2}-[01][0-9]-[0123][0-9]Comma delimited list of tenant IDs to request info from.
199762235015168516,199762235015168004Root level object per the json-api spec