Auvik
App · 25 actions
Work with Auvik network monitoring: read clients, devices, interfaces, networks, configuration backups, components, warranties and lifecycles, list and dismiss alerts, pull device, interface and service statistics, and start workflows on new or cleared alerts, new or offline devices, configuration changes and failing components.
Actions
| Action | What it does |
|---|---|
| Dismiss alert | Dismiss an alert, as a technician would in the Auvik dashboard. |
| Get alert | Get one alert: its name, severity, status, description, when it was detected, what it is about and any ticket it was sent to. |
| Get client details | Get one client's display name, type, subscription, trial dates and address. |
| Get component | Get one component: its name, type, device and whether it is OK. |
| Get configuration backup | Get one configuration backup: its device, when it was taken and whether it is the running configuration. |
| Get device | Get one device: its name, type, make and model, serial number, IP addresses, software and firmware, when it was last seen and whether it is online. |
| Get device availability | Get uptime or outage figures for devices over a period, one data point per minute, hour or day. |
| Get device statistics | Get bandwidth, CPU, memory, storage or packet figures for devices over a period, one data point per minute, hour or day. |
| Get device warranty | Get one device's warranty and service coverage, warranty end date and recommended software version. |
| Get interface | Get one interface: its type, MAC and IP addresses, speed, duplex, status, device and what it connects to. |
| Get interface statistics | Get bandwidth, utilization, packet loss, discard or packet figures for interfaces over a period, one data point per minute, hour or day. |
| Get network | Get one network: its name, type, scan status and the devices on it. |
| Get service statistics | Get ping time or ping packet figures for the services Auvik monitors (such as its internet connection check) over a period. |
| List alerts | List alerts Auvik raised, with their severity, status, description and what they are about, filtered by client, severity, status or time. |
| List client details | List every client under your main Auvik account with its display name, type, subscription, trial dates and address. |
| List clients | List the clients and multi-clients (Auvik's tenants) your Auvik user can see, with their ids and domain prefixes. |
| List components | List device components (CPUs, disks, fans, memory, power supplies and system boards) and whether each is OK, degraded or failed. |
| List configuration backups | List the configuration backups Auvik took of devices, with when each was taken and whether it is the running configuration. |
| List device lifecycles | List devices' end of sale, software maintenance, security maintenance and last support status, to plan replacements. |
| List device warranties | List devices' warranty and service coverage, warranty end dates and recommended software versions. |
| List devices | List devices Auvik has discovered, with their type, make and model, IP addresses, firmware and online status, filtered by client, type, status, vendor or network. |
| List interfaces | List device interfaces (ports) with their type, MAC and IP addresses, speed and status, filtered by device, type or status. |
| List networks | List networks Auvik has discovered (routed, VLAN, Wi-Fi and more), filtered by type, scan status or device. |
| List notes | List the notes people left in Auvik on clients, devices, networks and interfaces, with who changed each last. |
| List remote session audits | List the remote sessions (tunnels, terminals and remote browsers) people opened to devices through Auvik, with who, when and how each ended. |
Dismiss alert
Dismiss an alert, as a technician would in the Auvik dashboard.
Inputs
- Alert
alert_idtextRequired - The alert. Pick one of the last week's, or give its id from 'List alerts' or an alert trigger.
Outputs
alert_idtext- The alert dismissed
dismissedtrue/false- True once dismissed
Example output
{
"alert_id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"dismissed": true
}Get alert
Get one alert: its name, severity, status, description, when it was detected, what it is about and any ticket it was sent to.
Inputs
- Alert
alert_idtextRequired - The alert. Pick one of the last week's, or give its id from 'List alerts' or an alert trigger.
Outputs
alertobject- The alert
Example output
{
"alert": {
"attributes": {
"alertDefinitionId": "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo",
"description": "This printer is reporting an ink percentage of 20% for black ink",
"detectedOn": "2018-11-22T22:07:18.407Z",
"dismissed": false,
"dispatched": true,
"externalTicket": [
{
"id": "56003",
"system": "Webhook"
}
],
"name": "Printer - Low Ink Level",
"severity": "warning",
"specificationId": "-400",
"status": "created"
},
"id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292400",
"self": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
},
"relationships": {
"entity": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"relatedAlert": {
"data": {}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "alert"
}
}Get client details
Get one client's display name, type, subscription, trial dates and address.
Inputs
- Main account
domain_prefixtextRequired - Your main Auvik account's domain prefix, the first part of your dashboard's address (such as mspdemo in mspdemo.my.auvik.com).
- Client
tenant_idtextRequired - The client. Pick one, or give its id from an earlier step.
Outputs
tenantobject- The client
Example output
{
"tenant": {
"attributes": {
"address": {
"address1": "123 Some St.",
"address2": "Suite 321",
"city": "Waterloo",
"country": "Canada",
"postalCode": "N1A 2B3",
"state": "Ontario"
},
"displayName": "Example Company Inc.",
"domainPrefix": "sampledomain",
"enabled": true,
"running": true,
"subscribed": true,
"subscriptionOwner": "None",
"tenantType": "client",
"trialEndDate": "2017-01-01T12:00:00.000-0500",
"trialStartDate": "2017-01-01T12:00:00.000-0500"
},
"id": "195798545063742726",
"relationships": {
"authorizations": {
"data": [
{
"id": "(55849,7923)",
"type": "authorizations"
}
]
},
"parent": {
"data": {
"id": "0192837465",
"type": "tenants"
}
}
},
"type": "tenants"
}
}Get component
Get one component: its name, type, device and whether it is OK.
Inputs
- Component ID
component_idtextRequired - The component's id, from 'List components' or the 'Component degraded or failed' trigger.
Outputs
componentobject- The component
Example output
{
"component": {
"attributes": {
"componentName": "CPU Core 26",
"componentType": "cpu",
"currentStatus": "ok",
"lastModified": "2018-03-13T12:00:00.000Z"
},
"id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
},
"relationships": {
"parentDevice": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "component"
}
}Get configuration backup
Get one configuration backup: its device, when it was taken and whether it is the running configuration.
Inputs
- Configuration ID
configuration_idtextRequired - The backup's id, from 'List configuration backups' or the 'Configuration changed' trigger.
Outputs
configurationobject- The configuration backup
Example output
{
"configuration": {
"attributes": {
"backupTime": "2018-03-12T12:00:00.000Z",
"isRunning": true
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
},
"relationships": {
"device": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "configuration"
}
}Get device
Get one device: its name, type, make and model, serial number, IP addresses, software and firmware, when it was last seen and whether it is online.
Inputs
- Device
device_idtextRequired - The device. Pick one, or give its id from an earlier step.
- Include details
include_detailstrue/false - Also return each device's discovery status, whether it is managed, and its interfaces, components, configurations and connected devices.Default:
false.
Outputs
detailslist- Each device's details, when 'Include details' is on; otherwise empty
deviceobject- The device
Example output
{
"details": [
{
"attributes": {
"discoveryStatus": {
"login": "disabled",
"snmp": "privileged",
"vmware": "disabled",
"wmi": "disabled"
},
"manageStatus": true,
"trafficInsightsStatus": "notDetected"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"components": {
"data": []
},
"configurations": {
"data": []
},
"connectedDevices": {
"data": []
},
"interfaces": {
"data": [
{
"attributes": {
"interfaceName": "Interface 1",
"macAddress": "10:dd:b1:cb:ab:c6"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"type": "interface"
}
]
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceDetail"
}
],
"device": {
"attributes": {
"description": "Linux 3.3.8 #1 Fri Oct 13 11:12:44 PDT 2017 mips",
"deviceName": "MyAccessPoint",
"deviceType": "accessPoint",
"firmwareVersion": "unifi-v1.6.7.249-gb74e0282",
"ipAddresses": [
"10.0.0.1"
],
"lastModified": "2018-03-12T12:00:00.000Z",
"lastSeenTime": "2018-11-30T18:34:39.452Z",
"makeModel": "M Series Access Point",
"onlineStatus": "online",
"serialNumber": "1Q2W3E4R5T6Y",
"softwareVersion": "3.9.3.7537",
"vendorName": "Ubiquiti"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"deviceDetail": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "deviceDetail"
}
},
"networks": {
"data": [
{
"attributes": {
"networkName": "192.168.4.0/24"
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "network"
}
]
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "device"
}
}Get device availability
Get uptime or outage figures for devices over a period, one data point per minute, hour or day.
Inputs
- Statistic
statistictextRequired - Uptime or outage.One of:
uptime,outage. - From
from_timedate and timeRequired - Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until
thru_timedate and time - End of the period. Defaults to now.
- Interval
intervaltextRequired - How far apart the data points are.One of:
minute,hour,day. - Device
device_idtext - Only this device. Leave empty for every device.
- Device type
device_typetext - Only devices of this type.One of:
accessPoint(Access point),airConditioner(Air conditioner),alarm,audioVisual(Audio visual),backhaul,backupDevice(Backup device),bridge,buildingManagement(Building management),camera,chassis, and 38 more. - Skip time before discovery
omit_undiscoveredtrue/false - Leave out the time before Auvik first discovered each device.Default:
false. - Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
statisticslist- One entry per device
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"next_cursor": "",
"statistics": [
{
"attributes": {
"interval": "hour",
"reportPeriod": {
"fromTime": "2020-02-18T00:00:00.000Z",
"thruTime": "2020-02-19T00:00:00.000Z"
},
"statType": "uptime",
"stats": [
{
"data": [
[
"2020-02-18T00:00:00.000Z",
100
]
],
"index": "1",
"legend": [
"Time",
"Uptime"
],
"name": "Uptime",
"unit": [
"datetime",
"percentage"
]
}
]
},
"id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"device": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"interface": {
"data": {}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceAvailabilityStatistics"
}
],
"total_pages": 1
}Get device statistics
Get bandwidth, CPU, memory, storage or packet figures for devices over a period, one data point per minute, hour or day.
Inputs
- Statistic
statistictextRequired - What to measure.One of:
bandwidth,cpuUtilization(CPU utilization),memoryUtilization(Memory utilization),storageUtilization(Storage utilization),packetUnicast(Unicast packets),packetMulticast(Multicast packets),packetBroadcast(Broadcast packets). - From
from_timedate and timeRequired - Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until
thru_timedate and time - End of the period. Defaults to now.
- Interval
intervaltextRequired - How far apart the data points are.One of:
minute,hour,day. - Device
device_idtext - Only this device. Leave empty for every device.
- Device type
device_typetext - Only devices of this type.One of:
accessPoint(Access point),airConditioner(Air conditioner),alarm,audioVisual(Audio visual),backhaul,backupDevice(Backup device),bridge,buildingManagement(Building management),camera,chassis, and 38 more. - Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
statisticslist- One entry per device
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"next_cursor": "",
"statistics": [
{
"attributes": {
"interval": "hour",
"reportPeriod": {
"fromTime": "2020-02-18T00:00:00.000Z",
"thruTime": "2020-02-19T00:00:00.000Z"
},
"statType": "bandwidth",
"stats": [
{
"data": [
[
"2020-02-18T00:00:00.000Z",
1250000
]
],
"index": "1",
"legend": [
"Time",
"Bandwidth"
],
"name": "Total bandwidth",
"unit": [
"datetime",
"bitsPerSecond"
]
}
]
},
"id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"device": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"interface": {
"data": {}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceStatistics"
}
],
"total_pages": 1
}Get device warranty
Get one device's warranty and service coverage, warranty end date and recommended software version.
Inputs
- Device
device_idtextRequired - The device. Pick one, or give its id from an earlier step.
Outputs
warrantyobject- The device's warranty
Example output
{
"warranty": {
"attributes": {
"contractRenewalAvailability": "Available",
"deviceName": "MyAccessPoint",
"recommendedSoftwareVersion": "15.1(4)M12a - 06 Oct 2016",
"serviceAttachmentStatus": "Available",
"serviceCoverageStatus": "Covered",
"warrantyCoverageStatus": "Not Covered",
"warrantyExpirationDate": "2015-07-31T00:00:00.000Z"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceWarranty"
}
}Get interface
Get one interface: its type, MAC and IP addresses, speed, duplex, status, device and what it connects to.
Inputs
- Interface ID
interface_idtextRequired - The interface's id, from 'List interfaces' or an earlier step.
Outputs
interfaceobject- The interface
Example output
{
"interface": {
"attributes": {
"adminStatus": true,
"customConnections": false,
"duplex": "full",
"interfaceName": "Interface 1",
"interfaceType": "ethernet",
"ipAddresses": [
"10.0.0.1"
],
"lastModified": "2018-03-12T12:00:00.000Z",
"macAddress": "1A:2B:3C:4D:5E:6F",
"negotiatedSpeed": "1.0 Gbit/s",
"operationalStatus": "online"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
},
"relationships": {
"connectedTo": {
"data": []
},
"networks": {
"data": [
{
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "network"
}
]
},
"parentDevice": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "interface"
}
}Get interface statistics
Get bandwidth, utilization, packet loss, discard or packet figures for interfaces over a period, one data point per minute, hour or day.
Inputs
- Statistic
statistictextRequired - What to measure.One of:
bandwidth,utilization,packetLoss(Packet loss),packetDiscard(Discarded packets),packetUnicast(Unicast packets),packetMulticast(Multicast packets),packetBroadcast(Broadcast packets). - From
from_timedate and timeRequired - Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until
thru_timedate and time - End of the period. Defaults to now.
- Interval
intervaltextRequired - How far apart the data points are.One of:
minute,hour,day. - Interface ID
interface_idtext - Only this interface, by its id from 'List interfaces'.
- Device
device_idtext - Only this device's interfaces.
- Interface type
interface_typetext - Only interfaces of this type.One of:
ethernet,wifi(Wi-Fi),linkAggregation(Link aggregation),ieee8023AdLag(IEEE 802.3ad LAG),vlan,tunnel,loopback,optical,virtualNic(Virtual NIC),virtualSwitch(Virtual switch), and 20 more. - Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
statisticslist- One entry per interface
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"next_cursor": "",
"statistics": [
{
"attributes": {
"interval": "hour",
"reportPeriod": {
"fromTime": "2020-02-18T00:00:00.000Z",
"thruTime": "2020-02-19T00:00:00.000Z"
},
"statType": "bandwidth",
"stats": [
{
"data": [
[
"2020-02-18T00:00:00.000Z",
1250000
]
],
"index": "1",
"legend": [
"Time",
"Bandwidth"
],
"name": "Total bandwidth",
"unit": [
"datetime",
"bitsPerSecond"
]
}
]
},
"id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"device": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"interface": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"type": "interface"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "interfaceStatistics"
}
],
"total_pages": 1
}Get network
Get one network: its name, type, scan status and the devices on it.
Inputs
- Network
network_idtextRequired - The network. Pick one, or give its id from an earlier step.
- Include details
include_detailstrue/false - Also return each network's scope, collectors and excluded IP addresses.Default:
false.
Outputs
detailslist- Each network's details, when 'Include details' is on; otherwise empty
networkobject- The network
Example output
{
"details": [
{
"attributes": {
"collectorSelection": "automatic",
"excludedIpAddresses": [],
"primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
"scope": "private",
"secondaryCollectors": []
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
},
"relationships": {
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "networkDetail"
}
],
"network": {
"attributes": {
"description": "192.168.4.0/24",
"lastModified": "2018-03-12T12:00:00.000Z",
"networkName": "192.168.4.0/24",
"networkType": "routed",
"scanStatus": "true"
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
},
"relationships": {
"devices": {
"data": [
{
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
]
},
"networkDetail": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "networkDetail"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "network"
}
}Get service statistics
Get ping time or ping packet figures for the services Auvik monitors (such as its internet connection check) over a period.
Inputs
- Statistic
statistictextRequired - What to measure.One of:
pingTime(Ping time),pingPacket(Ping packets). - From
from_timedate and timeRequired - Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until
thru_timedate and time - End of the period. Defaults to now.
- Interval
intervaltextRequired - How far apart the data points are.One of:
minute,hour,day. - Service ID
service_idtext - Only this service, by its id. Leave empty for every service.
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
statisticslist- One entry per service
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"next_cursor": "",
"statistics": [
{
"attributes": {
"endpoints": [
{
"id": "NzkyMyw1NTcxNjU0Njc2MTQwODY4MTI",
"ipAddress": "192.0.2.10",
"stats": [
{
"data": [
[
"2020-02-18T00:00:00.000Z",
12
]
],
"index": "1",
"legend": [
"Time",
"Average"
],
"name": "Ping time",
"unit": [
"datetime",
"milliseconds"
]
}
]
}
],
"interval": "hour",
"reportPeriod": {
"fromTime": "2020-02-18T00:00:00.000Z",
"thruTime": "2020-02-19T00:00:00.000Z"
},
"statType": "pingTime"
},
"id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/stat/service/pingTime"
},
"relationships": {
"service": {
"data": {
"attributes": {
"serviceName": "Internet Connection Check"
},
"type": "service"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "serviceStatistics"
}
],
"total_pages": 1
}List alerts
List alerts Auvik raised, with their severity, status, description and what they are about, filtered by client, severity, status or time. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Severity
severitytext - Only alerts of this severity.One of:
emergency,critical,warning,info,unknown. - Status
statustext - Only triggered, cleared, paused or unpaused alerts.One of:
created(Triggered),resolved(Cleared),paused,unpaused. - About
entity_idtext - Only alerts about this device, interface or network, by its id.
- Dismissed
dismissedtext - Only dismissed alerts, or only those not dismissed.One of:
true(Yes),false(No). - Sent to an integration
dispatchedtext - Only alerts sent to a notification integration, or only those not sent.One of:
true(Yes),false(No). - Detected after
detected_afterdate and time - Only alerts detected after this time.
- Detected before
detected_beforedate and time - Only alerts detected at or before this time.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
alertslist- The alerts
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"alerts": [
{
"attributes": {
"alertDefinitionId": "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo",
"description": "This printer is reporting an ink percentage of 20% for black ink",
"detectedOn": "2018-11-22T22:07:18.407Z",
"dismissed": false,
"dispatched": true,
"externalTicket": [
{
"id": "56003",
"system": "Webhook"
}
],
"name": "Printer - Low Ink Level",
"severity": "warning",
"specificationId": "-400",
"status": "created"
},
"id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292400",
"self": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
},
"relationships": {
"entity": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"relatedAlert": {
"data": {}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "alert"
}
],
"count": 1,
"next_cursor": "",
"total_pages": 1
}List client details
List every client under your main Auvik account with its display name, type, subscription, trial dates and address.
Inputs
- Main account
domain_prefixtextRequired - Your main Auvik account's domain prefix, the first part of your dashboard's address (such as mspdemo in mspdemo.my.auvik.com).
- Only available clients
available_onlytrue/false - Only clients whose data the API can read.Default:
false.
Outputs
countnumber- How many
tenantslist- The clients' details
Example output
{
"count": 1,
"tenants": [
{
"attributes": {
"address": {
"address1": "123 Some St.",
"address2": "Suite 321",
"city": "Waterloo",
"country": "Canada",
"postalCode": "N1A 2B3",
"state": "Ontario"
},
"displayName": "Example Company Inc.",
"domainPrefix": "sampledomain",
"enabled": true,
"running": true,
"subscribed": true,
"subscriptionOwner": "None",
"tenantType": "client",
"trialEndDate": "2017-01-01T12:00:00.000-0500",
"trialStartDate": "2017-01-01T12:00:00.000-0500"
},
"id": "195798545063742726",
"relationships": {
"authorizations": {
"data": [
{
"id": "(55849,7923)",
"type": "authorizations"
}
]
},
"parent": {
"data": {
"id": "0192837465",
"type": "tenants"
}
}
},
"type": "tenants"
}
]
}List clients
List the clients and multi-clients (Auvik's tenants) your Auvik user can see, with their ids and domain prefixes.
Inputs
None.
Outputs
countnumber- How many
tenantslist- The clients
Example output
{
"count": 1,
"tenants": [
{
"attributes": {
"domainPrefix": "sampledomain",
"tenantType": "client"
},
"id": "195798545063742726",
"relationships": {
"parent": {
"data": {
"id": "0192837465",
"type": "tenant"
}
}
},
"type": "tenant"
}
]
}List components
List device components (CPUs, disks, fans, memory, power supplies and system boards) and whether each is OK, degraded or failed. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Device
device_idtext - Only this device's components.
- Status
current_statustext - Only components with this status.One of:
ok,degraded,failed. - Changed after
modified_afterdate and time - Only those changed after this time.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
componentslist- The components
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"components": [
{
"attributes": {
"componentName": "CPU Core 26",
"componentType": "cpu",
"currentStatus": "ok",
"lastModified": "2018-03-13T12:00:00.000Z"
},
"id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
},
"relationships": {
"parentDevice": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "component"
}
],
"count": 1,
"next_cursor": "",
"total_pages": 1
}List configuration backups
List the configuration backups Auvik took of devices, with when each was taken and whether it is the running configuration. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Device
device_idtext - Only this device's backups.
- Backed up after
backed_up_afterdate and time - Only backups taken after this time.
- Backed up before
backed_up_beforedate and time - Only backups taken before this time.
- Running
runningtext - Only running configurations, or only saved ones.One of:
true(Running configurations only),false(Saved (not running) configurations only). - Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
configurationslist- The configuration backups
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"configurations": [
{
"attributes": {
"backupTime": "2018-03-12T12:00:00.000Z",
"isRunning": true
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
},
"relationships": {
"device": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "configuration"
}
],
"count": 1,
"next_cursor": "",
"total_pages": 1
}List device lifecycles
List devices' end of sale, software maintenance, security maintenance and last support status, to plan replacements. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Sales availability
sales_availabilitytext - Only devices with this sales status.One of:
covered,available,expired,securityOnly(Security only),unpublished,empty. - Software maintenance
software_maintenance_statustext - Only devices with this software maintenance status.One of:
covered,available,expired,securityOnly(Security only),unpublished,empty. - Security maintenance
security_software_maintenance_statustext - Only devices with this security software maintenance status.One of:
covered,available,expired,securityOnly(Security only),unpublished,empty. - Last support
last_support_statustext - Only devices with this last support status.One of:
covered,available,expired,securityOnly(Security only),unpublished,empty. - Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
lifecycleslist- The devices' lifecycles
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"lifecycles": [
{
"attributes": {
"deviceName": "MyAccessPoint",
"lastSupportStatus": "available",
"salesAvailability": "available",
"securitySoftwareMaintenanceStatus": "available",
"softwareMaintenanceStatus": "available"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"device": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceLifecycle"
}
],
"next_cursor": "",
"total_pages": 1
}List device warranties
List devices' warranty and service coverage, warranty end dates and recommended software versions. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Under warranty
covered_under_warrantytext - Only devices under warranty, or only those that aren't.One of:
true(Yes),false(No). - Under a service contract
covered_under_servicetext - Only devices under a service contract, or only those that aren't.One of:
true(Yes),false(No). - Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
warrantieslist- The devices' warranties
Example output
{
"count": 1,
"next_cursor": "",
"total_pages": 1,
"warranties": [
{
"attributes": {
"contractRenewalAvailability": "Available",
"deviceName": "MyAccessPoint",
"recommendedSoftwareVersion": "15.1(4)M12a - 06 Oct 2016",
"serviceAttachmentStatus": "Available",
"serviceCoverageStatus": "Covered",
"warrantyCoverageStatus": "Not Covered",
"warrantyExpirationDate": "2015-07-31T00:00:00.000Z"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceWarranty"
}
]
}List devices
List devices Auvik has discovered, with their type, make and model, IP addresses, firmware and online status, filtered by client, type, status, vendor or network. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Device type
device_typetext - Only devices of this type.One of:
accessPoint(Access point),airConditioner(Air conditioner),alarm,audioVisual(Audio visual),backhaul,backupDevice(Backup device),bridge,buildingManagement(Building management),camera,chassis, and 38 more. - Status
online_statustext - Only devices with this status.One of:
online,offline,unreachable,testing,dormant,notPresent(Not present),lowerLayerDown(Lower layer down),unknown. - Network
network_idtext - Only devices on this network.
- Vendor
vendor_nametext - Only devices from this vendor, such as Cisco.
- Make and model
make_modeltext - Only devices of this model.
- Changed after
modified_afterdate and time - Only those changed after this time.
- Not seen since
not_seen_sincedate and time - Only devices Auvik hasn't seen online since this time.
- Include details
include_detailstrue/false - Also return each device's discovery status, whether it is managed, and its interfaces, components, configurations and connected devices.Default:
false. - Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
detailslist- Each device's details, when 'Include details' is on; otherwise empty
deviceslist- The devices
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"details": [
{
"attributes": {
"discoveryStatus": {
"login": "disabled",
"snmp": "privileged",
"vmware": "disabled",
"wmi": "disabled"
},
"manageStatus": true,
"trafficInsightsStatus": "notDetected"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"components": {
"data": []
},
"configurations": {
"data": []
},
"connectedDevices": {
"data": []
},
"interfaces": {
"data": [
{
"attributes": {
"interfaceName": "Interface 1",
"macAddress": "10:dd:b1:cb:ab:c6"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"type": "interface"
}
]
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "deviceDetail"
}
],
"devices": [
{
"attributes": {
"description": "Linux 3.3.8 #1 Fri Oct 13 11:12:44 PDT 2017 mips",
"deviceName": "MyAccessPoint",
"deviceType": "accessPoint",
"firmwareVersion": "unifi-v1.6.7.249-gb74e0282",
"ipAddresses": [
"10.0.0.1"
],
"lastModified": "2018-03-12T12:00:00.000Z",
"lastSeenTime": "2018-11-30T18:34:39.452Z",
"makeModel": "M Series Access Point",
"onlineStatus": "online",
"serialNumber": "1Q2W3E4R5T6Y",
"softwareVersion": "3.9.3.7537",
"vendorName": "Ubiquiti"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
},
"relationships": {
"deviceDetail": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "deviceDetail"
}
},
"networks": {
"data": [
{
"attributes": {
"networkName": "192.168.4.0/24"
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "network"
}
]
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "device"
}
],
"next_cursor": "",
"total_pages": 1
}List interfaces
List device interfaces (ports) with their type, MAC and IP addresses, speed and status, filtered by device, type or status. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Device
device_idtext - Only this device's interfaces.
- Interface type
interface_typetext - Only interfaces of this type.One of:
ethernet,wifi(Wi-Fi),linkAggregation(Link aggregation),ieee8023AdLag(IEEE 802.3ad LAG),vlan,tunnel,loopback,optical,virtualNic(Virtual NIC),virtualSwitch(Virtual switch), and 20 more. - Status
operational_statustext - Only interfaces with this status.One of:
online,offline,unreachable,testing,dormant,notPresent(Not present),lowerLayerDown(Lower layer down),unknown. - Admin status
admin_statustext - Only interfaces an admin has turned on, or only those turned off.One of:
true(Enabled),false(Disabled). - Changed after
modified_afterdate and time - Only those changed after this time.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
interfaceslist- The interfaces
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"interfaces": [
{
"attributes": {
"adminStatus": true,
"customConnections": false,
"duplex": "full",
"interfaceName": "Interface 1",
"interfaceType": "ethernet",
"ipAddresses": [
"10.0.0.1"
],
"lastModified": "2018-03-12T12:00:00.000Z",
"macAddress": "1A:2B:3C:4D:5E:6F",
"negotiatedSpeed": "1.0 Gbit/s",
"operationalStatus": "online"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
},
"relationships": {
"connectedTo": {
"data": []
},
"networks": {
"data": [
{
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "network"
}
]
},
"parentDevice": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "interface"
}
],
"next_cursor": "",
"total_pages": 1
}List networks
List networks Auvik has discovered (routed, VLAN, Wi-Fi and more), filtered by type, scan status or device. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- Network type
network_typetext - Only networks of this type.One of:
routed,vlan,wifi(Wi-Fi),loopback,network,layer2(Layer 2),internet. - Scan status
scan_statustext - Only networks Auvik is (or isn't) scanning.One of:
true(Scanning),false(Not scanning),notAllowed(Not allowed),unknown. - Device
device_idtext - Only networks this device is on.
- Changed after
modified_afterdate and time - Only those changed after this time.
- Include details
include_detailstrue/false - Also return each network's scope, collectors and excluded IP addresses.Default:
false. - Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
detailslist- Each network's details, when 'Include details' is on; otherwise empty
networkslist- The networks
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"details": [
{
"attributes": {
"collectorSelection": "automatic",
"excludedIpAddresses": [],
"primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
"scope": "private",
"secondaryCollectors": []
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
},
"relationships": {
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "networkDetail"
}
],
"networks": [
{
"attributes": {
"description": "192.168.4.0/24",
"lastModified": "2018-03-12T12:00:00.000Z",
"networkName": "192.168.4.0/24",
"networkType": "routed",
"scanStatus": "true"
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"links": {
"dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
},
"relationships": {
"devices": {
"data": [
{
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
]
},
"networkDetail": {
"data": {
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"type": "networkDetail"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "network"
}
],
"next_cursor": "",
"total_pages": 1
}List notes
List the notes people left in Auvik on clients, devices, networks and interfaces, with who changed each last. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- About
entity_idtext - Only notes on this device, network or interface, by its id.
- On
entity_typetext - Only notes on this kind of thing.One of:
root(Whole client),device,network,interface. - Name
entity_nametext - Only notes on something with this name.
- Last changed by
last_modified_bytext - Only notes last changed by this user.
- Changed after
modified_afterdate and time - Only those changed after this time.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
noteslist- The notes
total_pagesnumber- How many pages there are at this page size
Example output
{
"count": 1,
"next_cursor": "",
"notes": [
{
"attributes": {
"body": "This is a note about one of my networks.",
"entityId": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"entityName": "192.168.4.0/24",
"entityType": "network",
"lastModified": "2018-03-12T12:00:00.000Z",
"lastModifiedBy": "John User",
"title": "SomeNoteTitle"
},
"id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
},
"relationships": {
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "entityNote"
}
],
"total_pages": 1
}List remote session audits
List the remote sessions (tunnels, terminals and remote browsers) people opened to devices through Auvik, with who, when and how each ended. Gets one page; to see more, run it again with the next page it gives.
Inputs
- Clients
tenantslist - Which Auvik clients to read. A multi-client includes its clients. Leave empty to let Auvik choose, usually every client your Auvik user can see.
- User
usertext - Only sessions this user opened.
- Kind
categorytext - Only sessions of this kind.One of:
tunnel,terminal,remoteBrowser(Remote browser),unknown. - Status
statustext - Only sessions with this status.One of:
initiated,created,closed,failed,unknown. - Changed after
modified_afterdate and time - Only those changed after this time.
- Page size
page_sizenumber - How many to return, 1 to 1000. Auvik's default is 100.From 1 to 1000.
- Next page cursor
aftertext - The 'next_cursor' from an earlier page, to get the page after it.
Outputs
auditslist- The remote session audits
countnumber- How many came back on this page
next_cursortext- Give this as 'Next page cursor' to get the next page; empty on the last page
total_pagesnumber- How many pages there are at this page size
Example output
{
"audits": [
{
"attributes": {
"action": "create",
"category": "tunnel",
"cause": "",
"data": "This is some message or data related to this action",
"dateStarted": "2018-03-13T12:00:00.000Z",
"direction": "inbound",
"lastActive": "2018-03-12T12:00:00.000Z",
"status": "created",
"user": "John Smith"
},
"id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
"links": {
"dashboard": "",
"self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
},
"relationships": {
"device": {
"data": {
"attributes": {
"deviceName": "MyAccessPoint"
},
"id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
"type": "device"
}
},
"tenant": {
"data": {
"attributes": {
"domainPrefix": "sampledomain"
},
"id": "195798545063742726",
"type": "tenant"
}
}
},
"type": "entityAudit"
}
],
"count": 1,
"next_cursor": "",
"total_pages": 1
}