Auvik

Use the Dismiss Alert API to dismiss a specific alert that Auvik has triggered

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view billing information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2019-06-01</i> should be the date from which you want to query.</li> <li><i>2019-06-30</i> should be the date to which you want to query.</li> <li><i>199762235015168516</i> should be the IDs of list of IDs of the clients whose data you wish to query.</li> </ul>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view component statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2020-03-10T01:00:00.000Z</i> should be the date from which you want to query.</li> <li><i>2020-03-11T01:00:00.000Z</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>Each component type specified in the query path supports reporting statistics as indicated below: <table><tr><th>componentType</th><th>statId</th></tr><tr><td>cpu</td><td><ul><li>capacity</li><li>latency</li><li>readiness</li><li>ready</li><li>swap</li></ul></td></tr><tr><td>cpuCore</td><td><ul><li>idle</li><li>utilization</li></ul></td></tr><tr><td>disk</td><td><ul><li>latency</li><li>queueLatency</li><li>rate</li><li>totalLatency</li></ul></td></tr><tr><td>fan</td><td><ul><li>speed</li></ul></td></tr></tr><td>memory</td><td><ul><li>counters</li><li>swap</li><li>swapRate</li><li>temperature</li></ul></td></tr><tr><td>powerSupply</td><td><ul><li>power</li></ul></td></tr><tr><td>systemBoard</td><td><ul><li>temperature</li></ul></td></tr></table>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view device availability statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2020-03-10T01:00:00.000Z</i> should be the date from which you want to query.</li> <li><i>2020-03-11T01:00:00.000Z</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view device statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2020-03-10T01:00:00.000Z</i> should be the date from which you want to query.</li> <li><i>2020-03-11T01:00:00.000Z</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view billing information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2019-06-01</i> should be the date from which you want to query.</li> <li><i>2019-06-30</i> should be the date to which you want to query.</li> <li><i>MTk5...g2Nw</i> should be the ID of the device whose usage you want to query.</li> </ul>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view interface statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2020-03-10T01:00:00.000Z</i> should be the date from which you want to query.</li> <li><i>2020-03-11T01:00:00.000Z</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

Use the Read Multiple Alerts’ Info API to pull the collected information about the various alerts that Auvik has triggered.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view alert information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the tenant(s) whose data you wish to fetch information from. </li> <li><i>severity</i> and <i>warning</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable attributes.</li> </ul>

Use the Read Multiple ASM Applications' Info to retrieve the information related to the SaaS applications discovered within an ASM client deployment. This data includes the number of users of an application as well as key metadata such as whether the application is approved or unapproved.

The Read Multiple ASM Clients' Info API returns relevant meta data about clients that exist within the Auvik SaaS Management product. The response includes the number of total users as well as clientIDs which may be used to filter other relevant API calls.

Use the Read Multiple ASM Licenses' Info endpoint to retrieve information about an application licenses discovered within an ASM client deployment. This data includes the license type and associated user email assigned to each license, alongside other key metadata such as last login time. To access this data, a SaaS Ops integration with the desired application must be configured.

Use the Read Multiple ASM Security Logs' Info API to retrieve in depth information about the security logs within an Auvik SaaS Management client. Security logs include specific SaaS events, such as logins or downloads with timestamps for each event.

Use the Read Multiple ASM Tags' Info API to retrieve information about tags configured within an ASM client.

Use the Read Multiple ASM Users' Info API to retrieve information about any monitored users that exist within a specific Auvik SaaS Management tenant. ASM user data includes core information about the SaaS applications a monitored user is using as well as which accounts a user is leveraging to log into those applications.

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view component information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[currentStatus]=degraded</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view configuration history.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[deviceType]=router</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[deviceType]=router</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device extended details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[deviceType]=switch</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[deviceType]=router</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[salesAvailability]=available</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[coveredUnderWarranty]=true</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view entity audit history.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[status]=created</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view entity notes.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[entityType]=device</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view interface information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[interfaceType]=ethernet</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view network details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[networkType]=routed</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view network information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[networkType]=routed</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

Use Read SNMP Poller Setting's Devices API to pull the list of devices that apply to a specific SNMP Poller Setting Id.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view monitor settings information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>

Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view monitor settings information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2022-03-10 01:00:00</i> should be the date from which you want to query.</li> <li><i>2022-03-11 01:00:00</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view monitor settings information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2022-03-10 01:00:00</i> should be the date from which you want to query.</li> <li><i>2022-03-11 01:00:00</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

Use the Read Multiple SNMP Poller Settings API to pull the list of SNMP Poller Settings configured in Auvik.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view monitor settings information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>

Use the Read Multiple Tenants API to pull access detail about multiple multi-clients and clients associated with your Auvik user account.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view tenant information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>

Use the Read Multiple Tenants API to pull details for multiple multi-clients and clients associated with your main Auvik account.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view tenant information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>mspdemo</i> 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.</li></ul>

Use the Read OID Statistics API to fetch the last recorded value of a monitored device OID.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view device statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>

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.<br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view service statistics information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>2020-03-10T01:00:00.000Z</i> should be the date from which you want to query.</li> <li><i>2020-03-11T01:00:00.000Z</i> should be the date to which you want to query.</li> <li><i>hour</i> should be the reporting interval for the statistics that are returned.</li> </ul>

Use the Read Single Alert’s Info API to pull the collected information about a specific alert that Auvik has triggered.<br> <br> To find the alert IDs, run the <a href="#operation/readMultipleAlertInfo">Read Multiple Alerts API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view alert information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the tenant(s) whose data you wish to fetch information from. </li> <li><i>MTk...2Nw</i> should be the alert’s ID.</li> </ul>

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.<br> <br> To find the component IDs, run the <a href="#operation/readMultipleComponentInfo">Read Multiple Components’ Info API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view component information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...yMw</i> should be the component ID.</li> </ul>

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.<br> <br> To find the client IDs, run the <a href="#operation/readMultipleTenants">Read Multiple Tenants API.</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view configuration history.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>195798545063742726</i> should be the ID or comma delimited IDs of the client(s) whose data you wish to fetch information from. </li> <li><i>filter[deviceType]=router</i> should be whichever key and value pair you want to filter the result set by. See below for a list of filterable parameters.</li> </ul>

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.<br> <br> To find the device IDs, run the <a href="#operation/readMultipleDeviceInfo">Read Multiple Devices API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the device’s ID.</li> </ul>

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.<br> <br> To find the device IDs, run the <a href="#operation/readMultipleDeviceInfo">Read Multiple Devices API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device extended details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the device’s ID.</li> </ul>

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.<br> <br> To find the device IDs, run the <a href="#operation/readMultipleDeviceInfo">Read Multiple Devices API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the device’s ID. </li></ul>

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.<br> <br> To find the device IDs, run the <a href="#operation/readMultipleDeviceInfo">Read Multiple Devices API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the device’s ID. </li></ul>

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.<br> <br> To find the device IDs, run the <a href="#operation/readMultipleDeviceInfo">Read Multiple Devices API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view device information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the device’s ID. </li></ul>

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.<br> <br> To find the audit ID, run the <a href="#operation/readMultipleEntityAudit">Read Multiple Entity Audits API</a><br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view entity audit history.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...yMw</i> should be the audit’s ID.</li> </ul>

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.<br> <br> To find the note IDs the <a href="#operation/readMultipleEntityNote">Read Multiple Entity Notes API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view entity notes.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...yMw</i> should be the note ID.</li> </ul>

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.<br> <br> To find the interface IDs, run the <a href="#operation/readMultipleInterfaceInfo">Read Multiple Interfaces Info API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view interface information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...2Nw</i> should be the interface ID.</li> </ul>

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.<br> <br> To find the network IDs, run the <a href="#operations/readMultipleNetworkInfo">Read Multiple Networks API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view network details.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...yMw</i> should be the network’s ID.</li> </ul>

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.<br> <br> To find the network IDs, run the <a href="#operations/readMultipleNetworkInfo">Read Multiple Networks’ Info API</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to view network information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>MTk...yMw</i> should be the network ID.</li> </ul>

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.<br> <br> You can find the tenant ID for the multi-client or client by <a href="#operation/readMultipleTenantsDetail">Read Multiple Tenants Detail</a>.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user with permissions to edit Client Management.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> <li><i>322018492519875477</i> should be the tenant ID.</li> <li><i>mspdemo</i> 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.</li> </ul>

Use the Read Single SNMP Poller Setting API to pull details of a specific SNMP Poller Setting configured in Auvik.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li><i>user@example.com</i> should be the email address of a user with permissions to view monitor settings information.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>

Use the Verify Credentials API to verify your credentials are correct before making a call to an endpoint.<br> <br> Looking at the detail screen on the right, click cURL to see the command that will be used. Click <b>Copy</b> to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: <ul> <li>Within the API URL, <b>us1.my</b> (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.</li> <li><i>user@example.com</i> should be the email address of a user whose credentials you wish to check.</li> <li><i>apiKey</i> should be the API key that’s been set for the user.</li> </ul>