Actions & Endpoints

Become familiar with the actions available to use with your Auvik integration

Introduction

The Auvik Integration with Rewst delivers a robust set of actions and endpoints for interacting with Auvik networks and devices. Below is a summary of each section, highlighting the diverse capabilities and opportunities provided through the Auvik Integration:

• Alerts: Manage and retrieve alert information.

• Components: Access details of device components.

• Configurations: Handle device configurations.

• Devices: Explore details, warranties, and lifecycle information of devices.

• Entities: Retrieve notes and audits of discovered entities.

• Interfaces: List and fetch information about device interfaces.

• Networks: Access networks and specific network details.

• SNMP Poller: Retrieve SNMP Poller settings, devices, and history.

• Statistics: Obtain statistics for devices, interfaces, components, and OIDs.

• Tenants: Manage tenant details, including listing and specific information retrieval.

• Usage: Retrieve summaries of client and device usage.

API Actions

Alerts

The Alerts section encompasses three endpoints, providing capabilities to list alerts, retrieve specific alert information, and dismiss an alert. These functionalities enable you to stay informed and in control of your system's notifications, empowering you to manage alerts triggered by your Auvik collector(s) effectively.

Read Multiple Alerts’ Info

Use the Read Multiple Alerts’ Info API to pull the collected information about the various alerts that Auvik has triggered. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/alert/history/info

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of alertsResourceObject (object)

linksalertHistoryInfoReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/history/info?tenants=382911061747041209&filter[dismissed]=true'

Response

{
  "data": [
    {
      "type": "alert",
      "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
      "attributes": {
        "name": "Printer - Low Ink Level",
        "severity": "warning",
        "status": "created",
        "alertDefinitionId": "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo",
        "detectedOn": "2018-11-22T22:07:18.407Z",
        "description": "This printer is reporting an ink percentage of 20% for black ink",
        "dismissed": false,
        "dispatched": false,
        "externalTicket": [
          {
            "id": "56003",
            "system": "Connectwise_Cloud"
          }
        ]
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807",
        "self": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "relatedAlert": {
          "data": {
            "type": "alert",
            "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
            "attributes": {
              "name": "High Storage Utilization Cleared"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
            }
          }
        },
        "entity": {
          "data": {
            "type": "interface",
            "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
            }
          }
        }
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[last]=300"
  },
  "meta": {}
}

Read a Single Alert’s Info

Use the Read Single Alert’s Info API to pull the collected information about a specific alert that Auvik has triggered. To find the alert IDs, run the Read Multiple Alerts API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/alert/history/info/{id}

Path parameters

id*string

ID of alert

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataalertsResourceObject (object)

The template for a resource object representing an Alert message

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "alert",
    "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
    "attributes": {
      "name": "Printer - Low Ink Level",
      "severity": "warning",
      "status": "created",
      "alertDefinitionId": "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo",
      "detectedOn": "2018-11-22T22:07:18.407Z",
      "description": "This printer is reporting an ink percentage of 20% for black ink",
      "dismissed": false,
      "dispatched": false,
      "externalTicket": [
        {
          "id": "56003",
          "system": "Connectwise_Cloud"
        }
      ]
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807",
      "self": "https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "relatedAlert": {
        "data": {
          "type": "alert",
          "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
          "attributes": {
            "name": "High Storage Utilization Cleared"
          },
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
          }
        }
      },
      "entity": {
        "data": {
          "type": "interface",
          "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
          }
        }
      }
    }
  }
}

Dismiss an alert

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

POSThttps://auvikapi.us1.my.auvik.com/v1/alert/dismiss/{id}

Path parameters

id*string

ID of alert

Response

200400403500

Successful operation

Request

curl -X POST -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/dismiss/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Components

In the Components section, two specific endpoints enable you to access detailed information about device components discovered by Auvik. Whether you need to view multiple components or retrieve details about a specific component associated with a client device, this section provides the necessary tools to manage and understand your device components.

Read Multiple Components’ Info

Use the Read Multiple Components’ Info API to pull collected information about various device components Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/component/info

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of componentsResourceObject (object)

linkscomponentInfoReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?filter[currentStatus]=degraded&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "component",
      "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
      "attributes": {
        "componentName": "CPU Core 26",
        "componentType": "cpu",
        "currentStatus": "ok",
        "lastModified": "2018-03-13T12:00:00.000Z"
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "parentDevice": {
          "data": {
            "type": "device",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
            "attributes": {
              "deviceName": "ESXi-H153.MSC.MGMT"
            }
          }
        }
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[last]=300"
  },
  "meta": {}
}

Read a Single Component’s Info

Use the Read Single Component’s Info API to pull collected information about a specific device component Auvik has discovered. You’ll need the component ID you want audit detail for. To find the component IDs, run the Read Multiple Components’ Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/component/info/{id}

Path parameters

id*string

ID of component

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datacomponentsResourceObject (object)

The template for a resource object representing an Auvik component

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'

Response

{
  "data": {
    "type": "component",
    "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
    "attributes": {
      "componentName": "CPU Core 26",
      "componentType": "cpu",
      "currentStatus": "ok",
      "lastModified": "2018-03-13T12:00:00.000Z"
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "parentDevice": {
        "data": {
          "type": "device",
          "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "attributes": {
            "deviceName": "ESXi-H153.MSC.MGMT"
          }
        }
      }
    }
  }
}

Configurations

The Configurations section of the Auvik Integration provides endpoints to view details about device configurations discovered by Auvik. With specific endpoints for multiple and single device configurations, you can gain a thorough understanding of the device configuration history associated with your Auvik user account, ensuring optimal device management.

Read Multiple Device Configurations

Use the Read Multiple Device Configuration API to pull all device configurations. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/configuration

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of configResourceObject (object)

linksconfigReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "configuration",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "backupTime": "2018-03-12T12:00:00.000Z",
        "isRunning": true
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "device": {
          "data": {
            "type": "device",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "attributes": {
              "deviceName": "ESXi-H153.MSC.MGMT"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/configurations",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[last]=300"
  },
  "meta": {}
}

Read a Single Device Configuration

Use the Read Single Device Configuration API to pull a single device configuration. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/configuration/{id}

Path parameters

id*string

ID of configuration

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataconfigResourceObject (object)

The template for a resource object representing an Auvik device's configuration

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "configuration",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "attributes": {
      "backupTime": "2018-03-12T12:00:00.000Z",
      "isRunning": true
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "device": {
        "data": {
          "type": "device",
          "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
          "attributes": {
            "deviceName": "ESXi-H153.MSC.MGMT"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/configurations",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  }
}

Devices

The Devices section of the Auvik Integration offers an extensive suite of endpoints that allow you to access information about individual and multiple devices discovered by Auvik. This includes details, extended details, warranty information, and lifecycle data. These endpoints provide a granular view of the devices, enabling effective management and oversight.

Read a Single Device’s Info

Use the Read Single Device’s Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/info/{id}

Path parameters

id*string

ID of device

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadevicesResourceObject (object)

The template for a resource object representing an Auvik device

includedarray of deviceDetailsResourceObject (object)

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "device",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "attributes": {
      "ipAddresses": [
        "10.0.0.1"
      ],
      "deviceName": "MyAccessPoint",
      "deviceType": "accessPoint",
      "makeModel": "M Series Access Point",
      "vendorName": "Ubiquiti",
      "softwareVersion": "3.9.3.7537",
      "serialNumber": "1Q2W3E4R5T6Y",
      "description": "Linux 3.3.8 #1 Fri Oct 13 11:12:44 PDT 2017 mips",
      "firmwareVersion": "unifi-v1.6.7.249-gb74e0282",
      "lastModified": "2018-03-12T12:00:00.000Z",
      "lastSeenTime": "2018-11-30T18:34:39.452Z",
      "onlineStatus": "online"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "attributes": {
              "networkName": "192.168.4.0/24"
            },
            "links": {
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
            }
          }
        ]
      },
      "deviceDetail": {
        "data": {
          "type": "deviceDetail",
          "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  },
  "included": [
    {
      "type": "deviceDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "discoveryStatus": {
          "snmp": "disabled",
          "login": "disabled",
          "wmi": "disabled",
          "vmware": "disabled"
        },
        "manageStatus": false,
        "trafficInsightsStatus": "notDetected"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "connectedDevices": {
          "data": [
            {
              "id": "MTk5NzYyMjM1MDE1MTY4MDA0LDE5OTc2MjQ4MzgzMjYxMjM1NQ",
              "attributes": {
                "deviceName": "SomeOtherDevice"
              },
              "type": "device",
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "interfaces": {
          "data": [
            {
              "type": "interface",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "interfaceName": "Interface 1",
                "macAddress": "10:dd:b1:cb:ab:c6"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "configurations": {
          "data": [
            {
              "type": "configuration",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "isRunning": false,
                "backupTime": "2018-03-12T12:00:00.000Z"
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "components": {
          "data": [
            {
              "type": "component",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "componentName": "CPU Core 26",
                "componentType": "cpu"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/components/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ]
}

Read a Single Device’s Details

Use the Read Single Device’s Details API to pull extra collected information about a specific device Auvik has discovered not already included in the Device Info API. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/{id}

Path parameters

id*string

ID of device

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceDetailsResourceObject (object)

The template for a resource object representing an Auvik device's extra details

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "deviceDetail",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "attributes": {
      "discoveryStatus": {
        "snmp": "disabled",
        "login": "disabled",
        "wmi": "disabled",
        "vmware": "disabled"
      },
      "manageStatus": false,
      "trafficInsightsStatus": "notDetected"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "connectedDevices": {
        "data": [
          {
            "id": "MTk5NzYyMjM1MDE1MTY4MDA0LDE5OTc2MjQ4MzgzMjYxMjM1NQ",
            "attributes": {
              "deviceName": "SomeOtherDevice"
            },
            "type": "device",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112785923/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
            }
          }
        ]
      },
      "interfaces": {
        "data": [
          {
            "type": "interface",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
            "attributes": {
              "interfaceName": "Interface 1",
              "macAddress": "10:dd:b1:cb:ab:c6"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112785923/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
            }
          }
        ]
      },
      "configurations": {
        "data": [
          {
            "type": "configuration",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
            "attributes": {
              "isRunning": false,
              "backupTime": "2018-03-12T12:00:00.000Z"
            },
            "links": {
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
            }
          }
        ]
      },
      "components": {
        "data": [
          {
            "type": "component",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
            "attributes": {
              "componentName": "CPU Core 26",
              "componentType": "cpu"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/components/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
            }
          }
        ]
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  }
}

Read a Single Device’s Extended Details

Use the Read Single Device’s Extended Details API to get a device’s extended details. Many device types have information collected and tracked by Auvik that are unique to that device type. Use this endpoint to access such information for a given device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended/{id}

Path parameters

id*string

ID of device

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceExtendedDetailResourceObject (one of)

stack (all of)hypervisor (all of)controller (all of)accessPoint (all of)miscDevice (all of)

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "deviceExtendedDetail",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "links": {
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "info": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    },
    "attributes": {
      "deviceName": "SomeDevice",
      "lastModified": "2018-03-12T12:00:00.000Z",
      "lastSeenTime": "2018-11-30T18:34:39.452Z",
      "deviceType": "stack"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "attributes": {
              "networkName": "192.168.4.0/24"
            },
            "links": {
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
            }
          }
        ]
      },
      "deviceDetail": {
        "data": {
          "type": "deviceDetail",
          "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
          }
        }
      },
      "members": [
        {
          "id": "MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg",
          "type": "device",
          "attributes": {
            "memberName": "Stack Member 3",
            "makeModel": "Extreme Summit X250-48p",
            "memberNumber": "3",
            "memberRole": "member",
            "memberStatus": "waiting",
            "macAddress": "1A:2B:3C:4D:5E:6F",
            "softwarePriority": "1",
            "hardwarePriority": "1",
            "serialNumber": "123456789",
            "softwareRevision": "1.4.5.02"
          },
          "links": {
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg",
            "info": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg"
          }
        }
      ]
    }
  }
}

Read a Single Device’s Warranty Info

Use the Read Single Device’s Warranty Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/{id}

Path parameters

id*string

ID of device

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceWarrantyResourceObject (object)

The template for a resource object representing an Auvik device with warranty information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "deviceWarranty",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "attributes": {
      "deviceName": "MyAccessPoint",
      "serviceCoverageStatus": "Covered",
      "serviceAttachmentStatus": "Available",
      "contractRenewalAvailability": "Available",
      "warrantyCoverageStatus": "Not Covered",
      "warrantyExpirationDate": "2015-07-31T00:00:00.000Z",
      "recommendedSoftwareVersion": "15.1(4)M12a - 06 Oct 2016"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  }
}

Read a Single Device’s Lifecycle Info

Use the Read Single Device’s Lifecycle Info API to pull the collected information about a specific device Auvik has discovered. You’ll need the device ID for the specific device. To find the device IDs, run the Read Multiple Devices API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/{id}

Path parameters

id*string

ID of device

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceLifecycleResourceObject (object)

The template for a resource object representing an Auvik device with lifecycle information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "deviceLifecycle",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "attributes": {
      "deviceName": "MyAccessPoint",
      "salesAvailability": "available",
      "softwareMaintenanceStatus": "available",
      "securitySoftwareMaintenanceStatus": "available",
      "lastSupportStatus": "available"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "device": {
        "data": {
          "type": "device",
          "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
          "attributes": {
            "deviceName": "ESXi-H153.MSC.MGMT"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  }
}

Read Multiple Devices’ Info

Use the Read Multiple Devices’ Info API to pull the collected information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/info

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of devicesResourceObject (object)

includedarray of deviceDetailsResourceObject (object)

linksdeviceInfoReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?filter[deviceType]=router&tenants=195798545063742726&include=deviceDetail'

Response

{
  "data": [
    {
      "type": "device",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "ipAddresses": [
          "10.0.0.1"
        ],
        "deviceName": "MyAccessPoint",
        "deviceType": "accessPoint",
        "makeModel": "M Series Access Point",
        "vendorName": "Ubiquiti",
        "softwareVersion": "3.9.3.7537",
        "serialNumber": "1Q2W3E4R5T6Y",
        "description": "Linux 3.3.8 #1 Fri Oct 13 11:12:44 PDT 2017 mips",
        "firmwareVersion": "unifi-v1.6.7.249-gb74e0282",
        "lastModified": "2018-03-12T12:00:00.000Z",
        "lastSeenTime": "2018-11-30T18:34:39.452Z",
        "onlineStatus": "online"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "networks": {
          "data": [
            {
              "type": "network",
              "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "attributes": {
                "networkName": "192.168.4.0/24"
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
                "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
              }
            }
          ]
        },
        "deviceDetail": {
          "data": {
            "type": "deviceDetail",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "included": [
    {
      "type": "deviceDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "discoveryStatus": {
          "snmp": "disabled",
          "login": "disabled",
          "wmi": "disabled",
          "vmware": "disabled"
        },
        "manageStatus": false,
        "trafficInsightsStatus": "notDetected"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "connectedDevices": {
          "data": [
            {
              "id": "MTk5NzYyMjM1MDE1MTY4MDA0LDE5OTc2MjQ4MzgzMjYxMjM1NQ",
              "attributes": {
                "deviceName": "SomeOtherDevice"
              },
              "type": "device",
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "interfaces": {
          "data": [
            {
              "type": "interface",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "interfaceName": "Interface 1",
                "macAddress": "10:dd:b1:cb:ab:c6"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "configurations": {
          "data": [
            {
              "type": "configuration",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "isRunning": false,
                "backupTime": "2018-03-12T12:00:00.000Z"
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "components": {
          "data": [
            {
              "type": "component",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "componentName": "CPU Core 26",
                "componentType": "cpu"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/components/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[last]=300"
  },
  "meta": {}
}

Read Multiple Devices’ Details

Use the Read Multiple Devices’ Details API to pull extra collected information about the various devices Auvik has discovered not already included in the Device Info API. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/detail

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of deviceDetailsResourceObject (object)

linksdeviceDetailsReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "deviceDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "discoveryStatus": {
          "snmp": "disabled",
          "login": "disabled",
          "wmi": "disabled",
          "vmware": "disabled"
        },
        "manageStatus": false,
        "trafficInsightsStatus": "notDetected"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "connectedDevices": {
          "data": [
            {
              "id": "MTk5NzYyMjM1MDE1MTY4MDA0LDE5OTc2MjQ4MzgzMjYxMjM1NQ",
              "attributes": {
                "deviceName": "SomeOtherDevice"
              },
              "type": "device",
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "interfaces": {
          "data": [
            {
              "type": "interface",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "interfaceName": "Interface 1",
                "macAddress": "10:dd:b1:cb:ab:c6"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112785923/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "configurations": {
          "data": [
            {
              "type": "configuration",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "isRunning": false,
                "backupTime": "2018-03-12T12:00:00.000Z"
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        },
        "components": {
          "data": [
            {
              "type": "component",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
              "attributes": {
                "componentName": "CPU Core 26",
                "componentType": "cpu"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/components/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
              }
            }
          ]
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[last]=300"
  },
  "meta": {}
}

Read Multiple Devices’ Extended Details

Use the Read Multiple Devices’ Extended Details API to get many devices’ extended details. Many device types have information collected and tracked by Auvik that are unique to that device type. Use this endpoint to access such information for a given device. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of deviceExtendedDetailResourceObject (one of)

linksdeviceDetailsExtendedReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?filter[deviceType]=switch&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "deviceExtendedDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "links": {
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
        "info": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      },
      "attributes": {
        "deviceName": "SomeDevice",
        "lastModified": "2018-03-12T12:00:00.000Z",
        "lastSeenTime": "2018-11-30T18:34:39.452Z",
        "deviceType": "stack"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "networks": {
          "data": [
            {
              "type": "network",
              "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "attributes": {
                "networkName": "192.168.4.0/24"
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
                "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
              }
            }
          ]
        },
        "deviceDetail": {
          "data": {
            "type": "deviceDetail",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
            }
          }
        },
        "members": [
          {
            "id": "MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg",
            "type": "device",
            "attributes": {
              "memberName": "Stack Member 3",
              "makeModel": "Extreme Summit X250-48p",
              "memberNumber": "3",
              "memberRole": "member",
              "memberStatus": "waiting",
              "macAddress": "1A:2B:3C:4D:5E:6F",
              "softwarePriority": "1",
              "hardwarePriority": "1",
              "serialNumber": "123456789",
              "softwareRevision": "1.4.5.02"
            },
            "links": {
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg",
              "info": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg"
            }
          }
        ]
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[last]=300"
  },
  "meta": {}
}

Read Multiple Devices’ Warranty Info

Use the Read Multiple Devices’ Warranty API to pull the collected warranty information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of deviceWarrantyResourceObject (object)

linksdeviceWarrantyReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?filter[coveredUnderWarranty]=true&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "deviceWarranty",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "deviceName": "MyAccessPoint",
        "serviceCoverageStatus": "Covered",
        "serviceAttachmentStatus": "Available",
        "contractRenewalAvailability": "Available",
        "warrantyCoverageStatus": "Not Covered",
        "warrantyExpirationDate": "2015-07-31T00:00:00.000Z",
        "recommendedSoftwareVersion": "15.1(4)M12a - 06 Oct 2016"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[last]=300"
  },
  "meta": {}
}

Read Multiple Devices’ Lifecycle Info

Use the Read Multiple Devices’ Lifecycle API to pull the collected lifecycle information about the various devices Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of deviceLifecycleResourceObject (object)

linksdeviceLifecycleReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?filter[salesAvailability]=available&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "deviceLifecycle",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "deviceName": "MyAccessPoint",
        "salesAvailability": "available",
        "softwareMaintenanceStatus": "available",
        "securitySoftwareMaintenanceStatus": "available",
        "lastSupportStatus": "available"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "device": {
          "data": {
            "type": "device",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "attributes": {
              "deviceName": "ESXi-H153.MSC.MGMT"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[last]=300"
  },
  "meta": {}
}

Entities

The Entities section of the Auvik Integration provides insights into notes and audit trails associated with the entities (devices, networks, and interfaces) discovered by Auvik. With specific endpoints for multiple entity audits and notes, as well as individual entity audit and note retrieval, this section offers detailed information about your client entities, enhancing your understanding and control.

Read a Single Entity Note

Use the Read Single Entity Note API to pull the information about a specific entity note. You’ll need the entity note ID for the specific entity note. To find the note IDs the Read Multiple Entity Notes API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/{id}

Path parameters

id*string

ID of entity note

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datanoteResourceObject (object)

The template for a resource object representing an Auvik note

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'

Response

{
  "data": {
    "type": "entityNote",
    "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
    "attributes": {
      "title": "SomeNoteTitle",
      "body": "This is a note about one of my networks.",
      "entityId": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "entityType": "network",
      "entityName": "192.168.4.0/24",
      "lastModifiedBy": "John User",
      "lastModified": "2018-03-12T12:00:00.000Z"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
    }
  }
}

Read a Single Entity Audit

Use the Single Multiple Entity Audit API pull information about a single entity audit. You’ll need the audit entry ID for the specific audit. To find the audit ID, run the Read Multiple Entity Audits API Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/{id}

Path parameters

id*string

ID of entity audit

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataauditsResourceObject (object)

The template for a resource object representing an audit log

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'

Response

{
  "data": {
    "type": "entityAudit",
    "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
    "attributes": {
      "user": "John Smith",
      "category": "unknown",
      "action": "create",
      "direction": "inbound",
      "status": "created",
      "cause": "This is an error.",
      "data": "This is some message or data related to this action",
      "dateStarted": "2018-03-13T12:00:00.000Z",
      "lastActive": "2018-03-12T12:00:00.000Z"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "device": {
        "data": {
          "type": "device",
          "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "attributes": {
            "deviceName": "MyAccessPoint"
          }
        }
      }
    },
    "links": {
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
    }
  }
}

Read Multiple Entity Notes

Use the Read Multiple Entity Notes API pull information about multiple entity notes. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/entity/note

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of noteResourceObject (object)

linksentityNotesReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?filter[entityType]=device&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "entityNote",
      "id": "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA",
      "attributes": {
        "title": "SomeNoteTitle",
        "body": "This is a note about one of my networks.",
        "entityId": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
        "entityType": "network",
        "entityName": "192.168.4.0/24",
        "lastModifiedBy": "John User",
        "lastModified": "2018-03-12T12:00:00.000Z"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[last]=300"
  },
  "meta": {}
}

Read Multiple Entity Audits

Use the Read Multiple Entity Audits API pull information about multiple entity audits for you clients. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of auditsResourceObject (object)

linksentityAuditReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?filter[status]=created&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "entityAudit",
      "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "attributes": {
        "user": "John Smith",
        "category": "unknown",
        "action": "create",
        "direction": "inbound",
        "status": "created",
        "cause": "This is an error.",
        "data": "This is some message or data related to this action",
        "dateStarted": "2018-03-13T12:00:00.000Z",
        "lastActive": "2018-03-12T12:00:00.000Z"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "device": {
          "data": {
            "type": "device",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
            "attributes": {
              "deviceName": "MyAccessPoint"
            }
          }
        }
      },
      "links": {
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[last]=300"
  },
  "meta": {}
}

Interfaces

In the Interfaces section, two specific endpoints provide detailed information about device interfaces discovered by Auvik. Whether you need information about multiple interfaces or specific details about an individual interface, this section allows for comprehensive interface management.

Read a Single Interfaces Info

Use the Read Single Interface Info API to pull the collected information about a specific device interface Auvik has discovered. You’ll need the interface ID for the specific interface. To find the interface IDs, run the Read Multiple Interfaces Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/{id}

Path parameters

id*string

ID of interface

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datainterfaceResourceObject (object)

The template for a resource object representing an interface

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "interface",
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
    "attributes": {
      "interfaceName": "Interface 1",
      "interfaceType": "ethernet",
      "macAddress": "1A:2B:3C:4D:5E:6F",
      "negotiatedSpeed": "1.0 Gbit/s",
      "duplex": "full",
      "customConnections": false,
      "ipAddresses": [
        "10.0.0.1"
      ],
      "operationalStatus": "online",
      "adminStatus": false,
      "lastModified": "2018-03-12T12:00:00.000Z"
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "connectedTo": {
        "data": [
          {
            "id": "MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ",
            "type": "interface",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
            }
          }
        ]
      },
      "networks": {
        "data": [
          {
            "type": "network",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "attributes": {
              "networkName": "192.168.4.0/24"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
            }
          }
        ]
      },
      "parentDevice": {
        "data": {
          "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "type": "device",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
          }
        }
      }
    }
  }
}

Read Multiple Interfaces Info

Use the Read Multiple Interfaces Info API to pull the collected information about the various device interfaces Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/interface/info

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of interfaceResourceObject (object)

linksinterfaceInfoReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?filter[interfaceType]=ethernet&tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "interface",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw",
      "attributes": {
        "interfaceName": "Interface 1",
        "interfaceType": "ethernet",
        "macAddress": "1A:2B:3C:4D:5E:6F",
        "negotiatedSpeed": "1.0 Gbit/s",
        "duplex": "full",
        "customConnections": false,
        "ipAddresses": [
          "10.0.0.1"
        ],
        "operationalStatus": "online",
        "adminStatus": false,
        "lastModified": "2018-03-12T12:00:00.000Z"
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "connectedTo": {
          "data": [
            {
              "id": "MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ",
              "type": "interface",
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ"
              }
            }
          ]
        },
        "networks": {
          "data": [
            {
              "type": "network",
              "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "attributes": {
                "networkName": "192.168.4.0/24"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw"
              }
            }
          ]
        },
        "parentDevice": {
          "data": {
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
            "type": "device",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        }
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[last]=300"
  },
  "meta": {}
}

Networks

The Networks section enables users to view and manage details about networks discovered by Auvik. With specific endpoints for individual and multiple networks, you can access both the general overview of networks and specific details, enhancing your control over network management.

Read a Single Network’s Info

Use the Read Single Network’s Info API to pull the collected information about a specific network Auvik has discovered. You’ll need the network ID for the specific network. To find the network IDs, run the Read Multiple Networks’ Info API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/network/info/{id}

Path parameters

id*string

ID of network

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datanetworksResourceObject (object)

The template for a resource object representing an Auvik network

includedarray of networkDetailsResourceObject (object)

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'

Response

{
  "data": {
    "type": "network",
    "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
    "attributes": {
      "networkType": "routed",
      "networkName": "192.168.4.0/24",
      "description": "192.168.4.0/24",
      "scanStatus": "true",
      "lastModified": "2018-03-12T12:00:00.000Z"
    },
    "relationships": {
      "networkDetail": {
        "data": {
          "type": "networkDetail",
          "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
          "links": {
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      },
      "devices": {
        "data": [
          {
            "type": "device",
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
            "attributes": {
              "deviceName": "MyAccessPoint"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        ]
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  },
  "included": [
    {
      "type": "networkDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "attributes": {
        "scope": "private",
        "primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
        "secondaryCollectors": [
          "8e604713-7606-4e8c-8200-bd6d4317e069"
        ],
        "collectorSelection": "automatic",
        "excludedIpAddresses": [
          "192.168.4.10-192.168.4.25"
        ]
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112785923/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ]
}

Read Multiple Networks’ Info

Use the Read Multiple Networks’ Info API to pull the collected information about the various networks Auvik has discovered. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/network/info

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of networksResourceObject (object)

includedarray of networkDetailsResourceObject (object)

linksnetworkInfoReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?filter[networkType]=routed&tenants=195798545063742726&include=networkDetail'

Response

{
  "data": [
    {
      "type": "network",
      "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "attributes": {
        "networkType": "routed",
        "networkName": "192.168.4.0/24",
        "description": "192.168.4.0/24",
        "scanStatus": "true",
        "lastModified": "2018-03-12T12:00:00.000Z"
      },
      "relationships": {
        "networkDetail": {
          "data": {
            "type": "networkDetail",
            "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
            "links": {
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
              "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard"
            }
          }
        },
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "devices": {
          "data": [
            {
              "type": "device",
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
              "attributes": {
                "deviceName": "MyAccessPoint"
              },
              "links": {
                "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
                "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
              }
            }
          ]
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "included": [
    {
      "type": "networkDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "attributes": {
        "scope": "private",
        "primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
        "secondaryCollectors": [
          "8e604713-7606-4e8c-8200-bd6d4317e069"
        ],
        "collectorSelection": "automatic",
        "excludedIpAddresses": [
          "192.168.4.10-192.168.4.25"
        ]
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112785923/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[last]=300"
  },
  "meta": {}
}

Read a Single Network’s Details

Use the Read Single Networks’s Details API to pull extra collected information about a specific network Auvik has discovered not already included in the network Info API. You’ll need the network ID for the specific network. To find the network IDs, run the Read Multiple Networks API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/{id}

Path parameters

id*string

ID of network

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datanetworkDetailsResourceObject (object)

The template for a resource object representing an Auvik network's extra details

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "type": "networkDetail",
    "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
    "attributes": {
      "scope": "private",
      "primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
      "secondaryCollectors": [
        "8e604713-7606-4e8c-8200-bd6d4317e069"
      ],
      "collectorSelection": "automatic",
      "excludedIpAddresses": [
        "192.168.4.10-192.168.4.25"
      ]
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112785923/dashboard",
      "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
    }
  }
}

Read Multiple Networks’ Details

Use the Read Multiple Networks’ Details API to pull extra collected information about the various networks Auvik has discovered not already included in the Network Info API. You’ll need the client IDs for the clients you want to run the multiple read against. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/inventory/network/detail

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of networkDetailsResourceObject (object)

linksnetworkDetailsReadMultiple_links (object)

Pagination related links

metameta object

The meta object that contains non-standard meta-information

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?tenants=195798545063742726'

Response

{
  "data": [
    {
      "type": "networkDetail",
      "id": "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw",
      "attributes": {
        "scope": "private",
        "primaryCollector": "98a1790e-ec59-481f-8529-4f836b0bd1ca",
        "secondaryCollectors": [
          "8e604713-7606-4e8c-8200-bd6d4317e069"
        ],
        "collectorSelection": "automatic",
        "excludedIpAddresses": [
          "192.168.4.10-192.168.4.25"
        ]
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/network/199502791112785923/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[last]=300"
  },
  "meta": {}
}

SNMP Poller & History

The SNMP Poller & History section offers a set of endpoints to view and manage SNMP Poller Settings within Auvik. This includes details about multiple settings, specific SNMP Poller Settings, and historical values. It's designed to provide a comprehensive view of SNMP Polling configurations and their historical data.

Read Multiple SNMP Poller Settings

Use the Read Multiple SNMP Poller Settings API to pull the list of SNMP Poller Settings configured in Auvik. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/settings/snmppoller

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of snmpPollerSettingsResourceObject (object)

linkssnmpPollerSettingsRead_links (object)

Pagination related links

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller'

Response

{
  "data": [
    {
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "type": "snmpPollerSetting",
      "attributes": {
        "name": "Cisco CPU Usage",
        "protocol": "snmp",
        "oid": "1.3.6.1.4.1.17373.4.1.2.1.5.1",
        "type": "string",
        "useAs": "poller"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[last]=300"
  }
}

Read Single SNMP Poller Setting

Use the Read Single SNMP Poller Setting API to pull details of a specific SNMP Poller Setting configured in Auvik. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/{snmpPollerSettingId}

Path parameters

snmpPollerSettingId*string

ID of the SNMP Poller Setting to retrieve

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datasnmpPollerSettingSingleResourceObject (object)

The template for a resource object representing an Auvik SNMP Poller Setting

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'

Response

{
  "data": {
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "type": "snmpPollerSetting",
    "attributes": {
      "name": "Cisco CPU Usage",
      "protocol": "snmp",
      "oid": "1.3.6.1.4.1.17373.4.1.2.1.5.1",
      "type": "string",
      "useAs": "poller"
    },
    "relationships": {
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    }
  }
}

Read SNMP Poller Setting's Devices

Use Read SNMP Poller Setting's Devices API to pull the list of devices that apply to a specific SNMP Poller Setting Id. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/{snmpPollerSettingId}/devices

Path parameters

snmpPollerSettingId*string

ID of the SNMP Poller Setting that the devices apply to

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of snmpPollerSettingDeviceResourceObject (object)

linkssnmpPollerSettingDevicesRead_links (object)

Pagination related links

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices'

Response

{
  "data": [
    {
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "type": "snmpPollerSettingDevice",
      "attributes": {
        "name": "Cisco Router",
        "type": "accessPoint"
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "snmpPollerSetting": {
          "data": {
            "type": "snmpPollerSetting",
            "id": "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ",
            "attributes": {
              "name": "Cisco CPU Usage",
              "protocol": "snmp",
              "oid": "1.3.6.1.4.1.17373.4.1.2.1.5.1",
              "type": "string",
              "useAs": "poller"
            },
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        }
      },
      "links": {
        "dashboard": "http://office.local.auvik.com:9000/#entity/device/7798604142709656/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/NzkyMyw3Nzk4NjA0MTQyNzA5NjU2MzE="
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[last]=300"
  }
}

Read String SNMP Poller Setting's History

Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of snmpPollerStringHistoryResourceObject (object)

linkssnmpPollerStringHistoryRead_links (object)

Pagination related links

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string'

Response

{
  "data": [
    {
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "type": "snmpPollerHistoryStatistics",
      "attributes": {
        "reportPeriod": {
          "fromTime": "2020-02-18T00:00:00.000Z",
          "thruTime": "2020-02-19T00:00:00.000Z"
        },
        "stats": [
          {
            "legend": [
              "String Value"
            ],
            "data": [
              [
                "text"
              ]
            ]
          }
        ]
      },
      "relationships": {
        "snmpPollerSetting": {
          "data": {
            "type": "snmpPollerSetting",
            "id": "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        },
        "device": {
          "data": {
            "type": "device",
            "id": "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ"
          }
        },
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726"
          }
        }
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[last]=300"
  }
}

Read Numeric SNMP Poller Setting's History

Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of snmpPollerIntHistoryResourceObject (object)

linkssnmpPollerIntHistoryRead_links (object)

Pagination related links

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int'

Response

{
  "data": [
    {
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "type": "snmpPollerHistoryStatistics",
      "attributes": {
        "reportPeriod": {
          "fromTime": "2020-02-18T00:00:00.000Z",
          "thruTime": "2020-02-19T00:00:00.000Z"
        },
        "interval": "hour",
        "stats": [
          {
            "legend": [
              "String Value"
            ],
            "data": [
              [
                "text"
              ]
            ]
          }
        ]
      },
      "relationships": {
        "snmpPollerSetting": {
          "data": {
            "type": "snmpPollerSetting",
            "id": "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        },
        "device": {
          "data": {
            "type": "device",
            "id": "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ"
          }
        },
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726"
          }
        }
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int/?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int/?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100",
    "first": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int?page[last]=300"
  }
}

Statistics

The Statistics section of the Auvik Integration provides six endpoints for viewing various entity statistics monitored by Auvik. This includes device statistics, availability statistics, service statistics, interface statistics, component statistics, and OID statistics. These endpoints offer insights into historical and current statistics, enhancing monitoring capabilities.

Read Device Statistics

Use the Read Device Statistics API to fetch detailed statistics of a client’s (and client’s children if a multi-client) devices for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/device/{statId}

Path parameters

statId*enum

ID of statistic to return

bandwidthcpuUtilizationmemoryUtilizationstorageUtilizationpacketUnicastpacketMulticastpacketBroadcast

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceStatisticsResourceObject (object)

Device statistics resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth?filter[fromTime]=2020-03-10T01:00:00.000Z&filter[thruTime]=2020-03-11T01:00:00.000Z&filter[interval]=hour'

Response

{
  "data": {
    "id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
    "type": "deviceStatistics",
    "attributes": {
      "reportPeriod": {
        "fromTime": "2020-02-18T00:00:00.000Z",
        "thruTime": "2020-02-19T00:00:00.000Z"
      },
      "interval": "hour",
      "statType": "statTypeName",
      "stats": [
        {
          "name": "Statistic name",
          "index": "1",
          "legend": [
            "Statistic value"
          ],
          "unit": [
            "percent"
          ],
          "data": [
            []
          ]
        }
      ]
    },
    "relationships": {
      "device": {
        "data": {
          "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "type": "device",
          "deviceName": "sw-1138",
          "deviceType": "switch",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "self": "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read Device Availability Statistics

Use the Read Device Availability Statistics API to fetch detailed availability statistics of a client’s (and client’s children if a multi-client) devices for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/deviceAvailability/{statId}

Path parameters

statId*enum

ID of statistic to return

uptimeoutage

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceAvailabilityStatisticsResourceObject (object)

Device availability statistics resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/deviceAvailability/uptime?filter[fromTime]=2020-03-10T01:00:00.000Z&filter[thruTime]=2020-03-11T01:00:00.000Z&filter[interval]=hour'

Response

{
  "data": {
    "id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
    "type": "deviceAvailabilityStatistics",
    "attributes": {
      "reportPeriod": {
        "fromTime": "2020-02-18T00:00:00.000Z",
        "thruTime": "2020-02-19T00:00:00.000Z"
      },
      "interval": "hour",
      "statType": "statTypeName",
      "stats": [
        {
          "name": "Statistic name",
          "index": "1",
          "legend": [
            "Statistic value"
          ],
          "unit": [
            "percent"
          ],
          "data": [
            []
          ]
        }
      ]
    },
    "relationships": {
      "device": {
        "data": {
          "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "type": "device",
          "deviceName": "sw-1138",
          "deviceType": "switch",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "self": "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read Service Statistics

Use the Read Service Statistics API to fetch detailed statistics of a client’s (and client’s children if a multi-client) services for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/service/{statId}

Path parameters

statId*enum

ID of statistic to return

pingTimepingPacket

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataserviceStatisticsResourceObject (object)

Service statistics resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/service/pingTime?filter[fromTime]=2020-03-10T01:00:00.000Z&filter[thruTime]=2020-03-11T01:00:00.000Z&filter[interval]=hour'

Response

{
  "data": {
    "id": "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI",
    "type": "serviceStatistics",
    "attributes": {
      "reportPeriod": {
        "fromTime": "2020-02-18T00:00:00.000Z",
        "thruTime": "2020-02-19T00:00:00.000Z"
      },
      "interval": "hour",
      "statType": "statTypeName",
      "endpoints": [
        {
          "id": "NzkyMyw1NTcxNjU0Njc2MTQwODY4MTI",
          "ipAddress": "192.0.2.10",
          "stats": [
            {
              "name": "Statistic name",
              "index": "1",
              "legend": [
                "Statistic value"
              ],
              "unit": [
                "percent"
              ],
              "data": [
                []
              ]
            }
          ]
        }
      ]
    },
    "relationships": {
      "service": {
        "data": {
          "type": "service",
          "attributes": {
            "serviceName": "Internet Connection Check"
          },
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/service/199502791112896003/dashboard"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://auvikapi.us1.my.auvik.com/v1/inventory/service/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "self": "https://auvikapi.us1.my.auvik.com/v1/stat/service/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read Interface Statistics

Use the Read Interface Statistics API to fetch detailed statistics of a client's (and client's children if a multi-client) interfaces for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/interface/{statId}

Path parameters

statId*enum

ID of statistic to return

bandwidthutilizationpacketLosspacketDiscardpacketMulticastpacketUnicastpacketBroadcast

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datainterfaceStatisticsResourceObject (object)

Interface statistics resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/interface/bandwidth?filter[fromTime]=2020-03-10T01:00:00.000Z&filter[thruTime]=2020-03-11T01:00:00.000Z&filter[interval]=hour'

Response

{
  "data": {
    "id": "NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE",
    "type": "interfaceStatistics",
    "attributes": {
      "reportPeriod": {
        "fromTime": "2020-02-18T00:00:00.000Z",
        "thruTime": "2020-02-19T00:00:00.000Z"
      },
      "interval": "hour",
      "statType": "statTypeName",
      "stats": [
        {
          "name": "Statistic name",
          "index": "1",
          "legend": [
            "Statistic value"
          ],
          "unit": [
            "percent"
          ],
          "data": [
            []
          ]
        }
      ]
    },
    "relationships": {
      "interface": {
        "data": {
          "id": "NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE",
          "type": "device",
          "interfaceName": "Interface 1",
          "interfaceType": "ethernet",
          "parentDevice": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard",
            "parentDevice": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE",
      "self": "https://auvikapi.us1.my.auvik.com/v1/stat/interface/bandwidth/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read Component Statistics

Use the Read Component Statistics API to fetch detailed statistics of a client's (and client's children if a multi-client) components for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/component/{componentType}/{statId}

Path parameters

componentType*enum

Component type of statistic to return

cpucpuCorediskfanmemorypowerSupplysystemBoard

statId*enum

ID of statistic to return

capacitycountersidlelatencypowerqueueLatencyratereadinessreadyspeedswapswapRatetemperaturetotalLatencyutilization

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datacomponentStatisticsResourceObject (object)

Component statistics resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/component/cpu/latency?filter[fromTime]=2020-03-10T01:00:00.000Z&filter[thruTime]=2020-03-11T01:00:00.000Z&filter[interval]=hour'

Response

{
  "data": {
    "id": "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA",
    "type": "componentStatistics",
    "attributes": {
      "reportPeriod": {
        "fromTime": "2020-02-18T00:00:00.000Z",
        "thruTime": "2020-02-19T00:00:00.000Z"
      },
      "interval": "hour",
      "statType": "statTypeName",
      "stats": [
        {
          "name": "Statistic name",
          "index": "1",
          "legend": [
            "Statistic value"
          ],
          "unit": [
            "percent"
          ],
          "data": [
            []
          ]
        }
      ]
    },
    "relationships": {
      "component": {
        "data": {
          "id": "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA",
          "type": "device",
          "componentName": "Component 1",
          "componentType": "cpu",
          "parentDevice": "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA",
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#entity/component/199502791112896003/dashboard",
            "parentDevice": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
            "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE"
          }
        }
      },
      "tenant": {
        "data": {
          "type": "tenant",
          "id": "195798545063742726",
          "attributes": {
            "domainPrefix": "sampledomain"
          }
        }
      }
    },
    "links": {
      "dashboard": "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE",
      "self": "https://auvikapi.us1.my.auvik.com/v1/stat/component/cpu/latency/MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read OID Statistics

Use the Read OID Statistics API to fetch the last recorded value of a monitored device OID. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/stat/oid/{statId}

Path parameters

statId*enum

ID of statistic to return

deviceMonitor

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of deviceOidMonitorResourceObject (object)

linksdeviceOidMonitorRead_links (object)

Pagination related links

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/oid/deviceMonitor'

Response

{
  "data": [
    {
      "type": "deviceOidMonitor",
      "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "attributes": {
        "oid": "1.3.6.1.4.1.17373.4.1.2.1.5.1",
        "oidName": "Environmental probe",
        "value": 123
      },
      "relationships": {
        "tenant": {
          "data": {
            "type": "tenant",
            "id": "195798545063742726",
            "attributes": {
              "domainPrefix": "sampledomain"
            }
          }
        },
        "device": {
          "data": {
            "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
            "type": "device",
            "deviceType": "switch",
            "deviceName": "sw-1138",
            "links": {
              "dashboard": "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard",
              "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
            }
          }
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard",
        "self": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw"
      }
    }
  ],
  "links": {
    "next": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300",
    "prev": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300",
    "first": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[first]=300",
    "last": "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[last]=300"
  }
}

Tenants

With three endpoints, the Tenants section of the Auvik Integration enables users to view and manage access details to multi-clients or clients associated with an Auvik user account. It provides insights into permissions and detailed information about multiple tenants and individual tenant details.

Read Multiple Tenants

Use the Read Multiple Tenants API to pull access detail about multiple multi-clients and clients associated with your Auvik user account. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. [e-mail] should be the email address of a user with permissions to view tenant information. apiKey should be the API key that’s been set for the user.

GEThttps://auvikapi.us1.my.auvik.com/v1/tenants

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of tenantsResourceObject (object)

An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants'

Response

{
  "data": [
    {
      "type": "tenant",
      "id": "0987654321",
      "attributes": {
        "domainPrefix": "sampledomain",
        "tenantType": "corporateIt"
      },
      "relationships": {
        "parent": {
          "data": {
            "type": "tenant",
            "id": "0192837465"
          }
        }
      }
    }
  ]
}

Read Single Tenant Detail

Use the Read a Single Tenant API to pull detail about a specific multi-client and client associated with your main Auvik account. You’ll need the tenant ID for the specific multi-client or client you want detail for. You can find the tenant ID for the multi-client or client by Read Multiple Tenants Detail. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. [e-mail] should be the email address of a user with permissions to edit Client Management. apiKey should be the API key that’s been set for the user. 322018492519875477 should be the tenant ID. mspdemo should be the domain prefix of your main Auvik account. To locate your domain prefix, log into your Auvik dashboard and look at the URL in your browser’s address bar.

GEThttps://auvikapi.us1.my.auvik.com/v1/tenants/detail/{id}

Path parameters

id*string

ID of tenant

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datatenantDetailResourceObject (object)

The template for a resource object representing an Auvik legacy tenant

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants/detail/322018492519875477?tenantDomainPrefix=mspdemo'

Response

{
  "data": {
    "type": "tenants",
    "id": "0987654321",
    "attributes": {
      "domainPrefix": "sampledomain",
      "displayName": "Example Company Inc.",
      "tenantType": "corporateIt",
      "enabled": false,
      "subscribed": false,
      "subscriptionOwner": "None",
      "running": false,
      "trialStartDate": "2017-01-01T12:00:00.000-0500",
      "trialEndDate": "2017-01-01T12:00:00.000-0500",
      "address": {
        "address1": "123 Some St.",
        "address2": "Suite 321",
        "city": "Waterloo",
        "state": "Ontario",
        "postalCode": "N1A 2B3",
        "country": "Canada"
      }
    },
    "relationships": {
      "parent": {
        "data": {
          "type": "tenants",
          "id": "0192837465"
        }
      },
      "authorizations": {
        "data": [
          {
            "type": "authorizations",
            "id": "(55849,7923)"
          }
        ]
      }
    }
  }
}

Read Multiple Tenants Detail

Use the Read Multiple Tenants API to pull details for multiple multi-clients and clients associated with your main Auvik account. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command: Within the API URL, us1.my (https://auvikapi.us1.my.auvik.com) should be updated to match the region in which your account resides. To locate the region, log into your Auvik dashboard and look at the URL in your browser’s address bar. [e-mail] should be the email address of a user with permissions to view tenant information. apiKey should be the API key that’s been set for the user. mspdemo should be the domain prefix of your main Auvik account. To locate your domain prefix, log into your Auvik dashboard and look at the URL in your browser’s address bar.

GEThttps://auvikapi.us1.my.auvik.com/v1/tenants/detail

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of tenantDetailResourceObject (object)

An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants/detail?tenantDomainPrefix=mspdemo'

Response

{
  "data": [
    {
      "type": "tenants",
      "id": "0987654321",
      "attributes": {
        "domainPrefix": "sampledomain",
        "displayName": "Example Company Inc.",
        "tenantType": "corporateIt",
        "enabled": false,
        "subscribed": false,
        "subscriptionOwner": "None",
        "running": false,
        "trialStartDate": "2017-01-01T12:00:00.000-0500",
        "trialEndDate": "2017-01-01T12:00:00.000-0500",
        "address": {
          "address1": "123 Some St.",
          "address2": "Suite 321",
          "city": "Waterloo",
          "state": "Ontario",
          "postalCode": "N1A 2B3",
          "country": "Canada"
        }
      },
      "relationships": {
        "parent": {
          "data": {
            "type": "tenants",
            "id": "0192837465"
          }
        },
        "authorizations": {
          "data": [
            {
              "type": "authorizations",
              "id": "(55849,7923)"
            }
          ]
        }
      }
    }
  ]
}

Usage

The Usage section of the Auvik Integration, comprising two endpoints, allows users to view usage data that informs invoice calculations. Whether you need to access client usage or device usage, this section provides detailed insights into consumption over specified time ranges.

Read Device Usage

Use the Read Device Usage API to pull a summary of a client’s (and client’s children if a multi-client) usage for a given time range. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/billing/usage/device/{id}

Path parameters

id*string

ID of device

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

datadeviceUsageResourceObject (object)

Device usage resource object

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?filter[fromDate]=2019-06-01&filter[thruDate]=2019-06-30'

Response

{
  "data": {
    "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
    "type": "deviceUsage",
    "attributes": {
      "deviceName": "MyAccessPoint",
      "usagePeriod": {
        "startDate": "2019-06-01T00:00:00Z",
        "endDate": "2019-07-01T00:00:00Z",
        "lengthInDays": 30
      },
      "totalDays": 30,
      "averageDays": 1,
      "totalDaysByClientType": {
        "notier": 0,
        "light": 0,
        "essentials": 6,
        "performance": 24
      },
      "averageDaysByClientType": {
        "notier": 0,
        "light": 0,
        "essentials": 0.2,
        "performance": 0.8
      }
    },
    "relationships": {
      "client": {
        "data": {
          "id": "199762235015168004",
          "type": "clientUsage",
          "attributes": {
            "domainPrefix": "mspclient"
          },
          "links": {
            "dashboard": "https://sampledomain.my.auvik.com/#admin/settings/billingUsage",
            "tenantRecord": "https://auvikapi.us1.my.auvik.com/v1/tenants/detail/199762235015168516?tenantDomainPrefix=sampledomain",
            "self": "https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168516&from=2019-06-01&to=2019-06-30"
          }
        }
      }
    },
    "links": {
      "deviceRecord": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
      "self": "https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30"
    }
  }
}

Read Client Usage

Use the Read Client Usage API to pull a summary of a client’s (and client’s children if a multi-client) usage for a given time range. To find the client IDs, run the Read Multiple Tenants API. Looking at the detail screen on the right, click cURL to see the command that will be used. Click Copy to copy the details of the command to your clipboard. Be sure to edit the following parameters within the command:

GEThttps://auvikapi.us1.my.auvik.com/v1/billing/usage/client

Query parameters

Response

200400403404500

Successful operation

Body

application/vnd.api+json

dataarray of clientUsageResourceObject (object)

Request

curl -u '[e-mail]:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168516&filter[fromDate]=2019-06-01&filter[thruDate]=2019-06-30'

Response

{
  "data": [
    {
      "id": "199762235015168516",
      "type": "clientUsage",
      "attributes": {
        "domainPrefix": "sampledomain",
        "billableDays": 30,
        "usagePeriod": {
          "startDate": "2019-06-01T00:00:00Z",
          "endDate": "2019-07-01T00:00:00Z",
          "lengthInDays": 30
        },
        "deviceUsage": {
          "totalDays": 150,
          "averageDays": 5,
          "totalDaysByClientType": {
            "notier": 0,
            "light": 30,
            "essentials": 30,
            "performance": 120
          },
          "averageDaysByClientType": {
            "notier": 0,
            "light": 1,
            "essentials": 1,
            "performance": 4
          }
        },
        "clientUsage": {
          "totalDays": 150,
          "averagedDays": 5,
          "totalDaysByClientType": {
            "notier": 0,
            "light": 30,
            "essentials": 30,
            "performance": 120
          },
          "averageDaysByClientType": {
            "notier": 0,
            "light": 1,
            "essentials": 1,
            "performance": 4
          }
        }
      },
      "relationships": {
        "devices": {
          "data": [
            {
              "id": "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
              "type": "deviceUsage",
              "attributes": {
                "name": "MyAccessPoint",
                "totalDays": 30,
                "clientName": "sampledomain"
              },
              "links": {
                "deviceRecord": "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw",
                "self": "https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30"
              }
            }
          ]
        },
        "clients": {
          "data": [
            {
              "id": "199762235015168004",
              "type": "clientUsage",
              "attributes": {
                "domainPrefix": "mspclient",
                "totalBillableDays": 30
              },
              "links": {
                "self": "https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168004&from=2019-06-01&to=2019-06-30"
              }
            }
          ]
        }
      },
      "links": {
        "dashboard": "https://sampledomain.my.auvik.com/#admin/settings/billingUsage",
        "tenantRecord": "https://auvikapi.us1.my.auvik.com/v1/tenants/detail/199762235015168516?tenantDomainPrefix=sampledomain",
        "self": "https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168516&from=2019-06-01&to=2019-06-30"
      }
    }
  ]
}