# Auvik

> 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.

App · 25 actions. Web page: https://docs.lodol.com/docs/integrations/auvik

## Actions

### Dismiss alert

Dismiss an alert, as a technician would in the Auvik dashboard.

**Inputs**

- Alert (`alert_id`, text, required): The alert. Pick one of the last week's, or give its id from 'List alerts' or an alert trigger.

**Outputs**

- `alert_id` (text): The alert dismissed
- `dismissed` (true/false): True once dismissed

**Example output**

```json
{
  "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_id`, text, required): The alert. Pick one of the last week's, or give its id from 'List alerts' or an alert trigger.

**Outputs**

- `alert` (object): The alert

**Example output**

```json
{
  "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_prefix`, text, required): 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_id`, text, required): The client. Pick one, or give its id from an earlier step.

**Outputs**

- `tenant` (object): The client

**Example output**

```json
{
  "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_id`, text, required): The component's id, from 'List components' or the 'Component degraded or failed' trigger.

**Outputs**

- `component` (object): The component

**Example output**

```json
{
  "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_id`, text, required): The backup's id, from 'List configuration backups' or the 'Configuration changed' trigger.

**Outputs**

- `configuration` (object): The configuration backup

**Example output**

```json
{
  "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_id`, text, required): The device. Pick one, or give its id from an earlier step.
- Include details (`include_details`, true/false): Also return each device's discovery status, whether it is managed, and its interfaces, components, configurations and connected devices. Default: `false`.

**Outputs**

- `details` (list): Each device's details, when 'Include details' is on; otherwise empty
- `device` (object): The device

**Example output**

```json
{
  "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 (`statistic`, text, required): Uptime or outage. One of: `uptime`, `outage`.
- From (`from_time`, date and time, required): Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until (`thru_time`, date and time): End of the period. Defaults to now.
- Interval (`interval`, text, required): How far apart the data points are. One of: `minute`, `hour`, `day`.
- Device (`device_id`, text): Only this device. Leave empty for every device.
- Device type (`device_type`, text): 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_undiscovered`, true/false): Leave out the time before Auvik first discovered each device. Default: `false`.
- Clients (`tenants`, list): 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_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `statistics` (list): One entry per device
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`statistic`, text, required): 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_time`, date and time, required): Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until (`thru_time`, date and time): End of the period. Defaults to now.
- Interval (`interval`, text, required): How far apart the data points are. One of: `minute`, `hour`, `day`.
- Device (`device_id`, text): Only this device. Leave empty for every device.
- Device type (`device_type`, text): 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 (`tenants`, list): 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_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `statistics` (list): One entry per device
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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_id`, text, required): The device. Pick one, or give its id from an earlier step.

**Outputs**

- `warranty` (object): The device's warranty

**Example output**

```json
{
  "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_id`, text, required): The interface's id, from 'List interfaces' or an earlier step.

**Outputs**

- `interface` (object): The interface

**Example output**

```json
{
  "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 (`statistic`, text, required): What to measure. One of: `bandwidth`, `utilization`, `packetLoss` (Packet loss), `packetDiscard` (Discarded packets), `packetUnicast` (Unicast packets), `packetMulticast` (Multicast packets), `packetBroadcast` (Broadcast packets).
- From (`from_time`, date and time, required): Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until (`thru_time`, date and time): End of the period. Defaults to now.
- Interval (`interval`, text, required): How far apart the data points are. One of: `minute`, `hour`, `day`.
- Interface ID (`interface_id`, text): Only this interface, by its id from 'List interfaces'.
- Device (`device_id`, text): Only this device's interfaces.
- Interface type (`interface_type`, text): 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 (`tenants`, list): 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_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `statistics` (list): One entry per interface
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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_id`, text, required): The network. Pick one, or give its id from an earlier step.
- Include details (`include_details`, true/false): Also return each network's scope, collectors and excluded IP addresses. Default: `false`.

**Outputs**

- `details` (list): Each network's details, when 'Include details' is on; otherwise empty
- `network` (object): The network

**Example output**

```json
{
  "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 (`statistic`, text, required): What to measure. One of: `pingTime` (Ping time), `pingPacket` (Ping packets).
- From (`from_time`, date and time, required): Start of the period. Keep long periods to a coarse interval: the more data points, the longer Auvik takes.
- Until (`thru_time`, date and time): End of the period. Defaults to now.
- Interval (`interval`, text, required): How far apart the data points are. One of: `minute`, `hour`, `day`.
- Service ID (`service_id`, text): Only this service, by its id. Leave empty for every service.
- Clients (`tenants`, list): 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_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `statistics` (list): One entry per service
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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 (`severity`, text): Only alerts of this severity. One of: `emergency`, `critical`, `warning`, `info`, `unknown`.
- Status (`status`, text): Only triggered, cleared, paused or unpaused alerts. One of: `created` (Triggered), `resolved` (Cleared), `paused`, `unpaused`.
- About (`entity_id`, text): Only alerts about this device, interface or network, by its id.
- Dismissed (`dismissed`, text): Only dismissed alerts, or only those not dismissed. One of: `true` (Yes), `false` (No).
- Sent to an integration (`dispatched`, text): Only alerts sent to a notification integration, or only those not sent. One of: `true` (Yes), `false` (No).
- Detected after (`detected_after`, date and time): Only alerts detected after this time.
- Detected before (`detected_before`, date and time): Only alerts detected at or before this time.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `alerts` (list): The alerts
- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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_prefix`, text, required): 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_only`, true/false): Only clients whose data the API can read. Default: `false`.

**Outputs**

- `count` (number): How many
- `tenants` (list): The clients' details

**Example output**

```json
{
  "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**

- `count` (number): How many
- `tenants` (list): The clients

**Example output**

```json
{
  "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 (`tenants`, list): 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_id`, text): Only this device's components.
- Status (`current_status`, text): Only components with this status. One of: `ok`, `degraded`, `failed`.
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `components` (list): The components
- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_id`, text): Only this device's backups.
- Backed up after (`backed_up_after`, date and time): Only backups taken after this time.
- Backed up before (`backed_up_before`, date and time): Only backups taken before this time.
- Running (`running`, text): Only running configurations, or only saved ones. One of: `true` (Running configurations only), `false` (Saved (not running) configurations only).
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `configurations` (list): The configuration backups
- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_availability`, text): Only devices with this sales status. One of: `covered`, `available`, `expired`, `securityOnly` (Security only), `unpublished`, `empty`.
- Software maintenance (`software_maintenance_status`, text): Only devices with this software maintenance status. One of: `covered`, `available`, `expired`, `securityOnly` (Security only), `unpublished`, `empty`.
- Security maintenance (`security_software_maintenance_status`, text): Only devices with this security software maintenance status. One of: `covered`, `available`, `expired`, `securityOnly` (Security only), `unpublished`, `empty`.
- Last support (`last_support_status`, text): Only devices with this last support status. One of: `covered`, `available`, `expired`, `securityOnly` (Security only), `unpublished`, `empty`.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `lifecycles` (list): The devices' lifecycles
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_warranty`, text): Only devices under warranty, or only those that aren't. One of: `true` (Yes), `false` (No).
- Under a service contract (`covered_under_service`, text): Only devices under a service contract, or only those that aren't. One of: `true` (Yes), `false` (No).
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size
- `warranties` (list): The devices' warranties

**Example output**

```json
{
  "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 (`tenants`, list): 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_type`, text): 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_status`, text): Only devices with this status. One of: `online`, `offline`, `unreachable`, `testing`, `dormant`, `notPresent` (Not present), `lowerLayerDown` (Lower layer down), `unknown`.
- Network (`network_id`, text): Only devices on this network.
- Vendor (`vendor_name`, text): Only devices from this vendor, such as Cisco.
- Make and model (`make_model`, text): Only devices of this model.
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Not seen since (`not_seen_since`, date and time): Only devices Auvik hasn't seen online since this time.
- Include details (`include_details`, true/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_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `details` (list): Each device's details, when 'Include details' is on; otherwise empty
- `devices` (list): The devices
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_id`, text): Only this device's interfaces.
- Interface type (`interface_type`, text): 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_status`, text): Only interfaces with this status. One of: `online`, `offline`, `unreachable`, `testing`, `dormant`, `notPresent` (Not present), `lowerLayerDown` (Lower layer down), `unknown`.
- Admin status (`admin_status`, text): Only interfaces an admin has turned on, or only those turned off. One of: `true` (Enabled), `false` (Disabled).
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `interfaces` (list): The interfaces
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_type`, text): Only networks of this type. One of: `routed`, `vlan`, `wifi` (Wi-Fi), `loopback`, `network`, `layer2` (Layer 2), `internet`.
- Scan status (`scan_status`, text): Only networks Auvik is (or isn't) scanning. One of: `true` (Scanning), `false` (Not scanning), `notAllowed` (Not allowed), `unknown`.
- Device (`device_id`, text): Only networks this device is on.
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Include details (`include_details`, true/false): Also return each network's scope, collectors and excluded IP addresses. Default: `false`.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `details` (list): Each network's details, when 'Include details' is on; otherwise empty
- `networks` (list): The networks
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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_id`, text): Only notes on this device, network or interface, by its id.
- On (`entity_type`, text): Only notes on this kind of thing. One of: `root` (Whole client), `device`, `network`, `interface`.
- Name (`entity_name`, text): Only notes on something with this name.
- Last changed by (`last_modified_by`, text): Only notes last changed by this user.
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `notes` (list): The notes
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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 (`tenants`, list): 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 (`user`, text): Only sessions this user opened.
- Kind (`category`, text): Only sessions of this kind. One of: `tunnel`, `terminal`, `remoteBrowser` (Remote browser), `unknown`.
- Status (`status`, text): Only sessions with this status. One of: `initiated`, `created`, `closed`, `failed`, `unknown`.
- Changed after (`modified_after`, date and time): Only those changed after this time.
- Page size (`page_size`, number): How many to return, 1 to 1000. Auvik's default is 100. From 1 to 1000.
- Next page cursor (`after`, text): The 'next_cursor' from an earlier page, to get the page after it.

**Outputs**

- `audits` (list): The remote session audits
- `count` (number): How many came back on this page
- `next_cursor` (text): Give this as 'Next page cursor' to get the next page; empty on the last page
- `total_pages` (number): How many pages there are at this page size

**Example output**

```json
{
  "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
}
```
