{ "openapi" : "3.0.1", "info" : { "title" : "Auvik API", "description" : "To use the Auvik APIs, you’ll need a valid Auvik user and the user’s API key. The user must also have the correct role permissions.
\n
\n Note: The word tenant as it appears in the API descriptions means one of Auvik’s supported tenant types: multi-client or client.

All date formats are formatted in the format of YYYY-MM-DDTHH:MM:SS.sssZ, as describe in ISO 8061

To find out more about Auvik’s APIs, click here.", "version" : "v1", "x-logo" : { "url" : "https://d3kgwklcu683cv.cloudfront.net/global-assets/auvik-logo.png" } }, "servers" : [ { "url" : "https://auvikapi.us1.my.auvik.com/v1" } ], "security" : [ { "ApiKey" : [ ] } ], "tags" : [ { "name" : "Device", "description" : "The Auvik Device API allows you to view an inventory of devices and other related information discovered by Auvik.
\n
\nThere are ten endpoints available within the Device API.\n
    \n
  1. Read Multiple Devices’ Info: Pulls detail about multiple devices discovered on your client’s network.
    2. \n
  2. Read a Single Device’s Info: Pulls detail about a specific device discovered on your client’s network.
    3. \n
  3. Read Multiple Devices’ Details: Pulls details about multiple devices not already included in the Device Info API.
    4. \n
  4. Read a Single Device’s Details: Pulls details about a specific device not already included in the Device Info API.
    5. \n
  5. Read Multiple Device’s Extended Details: Pulls extended information about multiple devices not already included in the Device Info API.
    6. \n
  6. Read a Single Device’s Extended Details: Pulls extended information about a specific device not already included in the Device Info API.
    7. \n
  7. Read Multiple Devices’ Warranty Info: Pulls the collected warranty information about the various devices discovered on your client’s network.
    8. \n
  8. Read a Single Device’s Warranty Info: Pulls the collected warranty information about a specific device discovered on your client’s network.
    9. \n
  9. Read Multiple Devices’ Lifecycle Info: Pulls the lifecycle information about the various devices discovered on your client’s network.
    10. \n
  10. Read a Single Device’s Lifecycle Info: Pulls the lifecycle information about a specific device discovered on your client’s network.
" }, { "name" : "Network", "description" : "The Auvik Network API allows you to view an inventory of networks and other related information discovered by Auvik.
\n
\nThere are four endpoints available within the Network API.\n
    \n
  1. Read Multiple Networks’ Details: Pulls extra collected information about multiple discovered networks.
    2. \n
  2. Read a Single Network’s Details: Pulls extra collected information about a specific discovered network.
    3. \n
  3. Read Multiple Networks’ Info: Pulls detail about multiple discovered networks.
    4. \n
  4. Read a Single Network’s Info: Pulls detail about a specific discovered network.
    5. \n
" }, { "name" : "Interface", "description" : "The Auvik Interface API allows you to view an inventory of device interfaces and other related information discovered by Auvik.
\n
\nThere are two endpoints available within the Interface API.\n
    \n
  1. Read Multiple Interfaces Info: Pulls detail about multiple interfaces associated with your clients’ devices.
    2. \n
  2. Read a Single Interface Info: Pulls detail about a specific interface associated with a client device.
    3. \n
" }, { "name" : "Component", "description" : "The Auvik Component API allows you to view an inventory of device components and other related information discovered by Auvik.
\n
\nThere are two endpoints available within the Component API.\n
    \n
  1. Read Multiple Components’ Info: Pulls detail about multiple components associated with your clients’ devices.
    2. \n
  2. Read a Single Component’s Info: Pulls detail about a specific component associated with a client device.
    3. \n
" }, { "name" : "Entity", "description" : "The Auvik Entity API allows you to view notes and audit trails associated with the entities (devices, networks, and interfaces) that have been discovered by Auvik.
\n
\nThere are four endpoints available within the Entity API.\n
    \n
  1. Read Multiple Entity Audits: Pulls detail about multiple audits associated with client entities.
    2. \n
  2. Read a Single Entity Audit: Pulls detail about a specific audit entry associated with a client entity.
    3. \n
  3. Read Multiple Entity Notes: Pulls detail about multiple notes associated with client entities.
    4. \n
  4. Read a Single Entity Note: Pulls detail about a specific note associated with a client entity.
    5. \n
" }, { "name" : "Credentials", "description" : "The Credentials API allows you to perform operations relating to your API credentials.
\n
\nThere is one endpoint currently available within the Credentials API.\n
    \n
  1. Verify Credentials: Verify that your credentials are correct before making a call to an endpoint.
    2. \n
" }, { "name" : "Tenants", "description" : "The Auvik Tenant API allows you to see if you have access to multi-clients or clients associated to your Auvik user account. The output from the API shows if you have permissions to a multi-client or client, but doesn’t show the associated role permissions.
\n
\n There are three endpoints within the Tenant API.\n
    \n
  1. Read Multiple Tenants: Pulls access detail about multiple multi-clients and clients associated with your Auvik user account.
    2. \n
  2. Read Multiple Tenants Detail: Pulls details for multiple multi-clients and clients associated with your Auvik user account.
    3. \n
  3. Read single Tenant Detail: Pulls detail for a specific multiple multi-client or client associated with your Auvik user account.
    4. \n
" }, { "name" : "Configuration", "description" : "The Configuration API allows you to view a history of device configurations and other related information discovered by Auvik.
\n
\n There are two endpoint within the Configuration API.\n
    \n
  1. Read Multiple Configurations. Pulls detail about multiple device configurations associated with your Auvik user account.
    2. \n
  2. Read Single Configuration. Pulls detail about a single device configuration associated with your Auvik user account.
    3. \n
" }, { "name" : "Alert History", "description" : "The Auvik Alert API allows you to view the alert events that has been triggered by your Auvik collector(s).
\n
\nThere are two endpoints available within the Alert API.\n
    \n
  1. Read Multiple Alerts. Read multiple alerts based on query parameters you specify.
    2. \n
  2. Read a Single Alert. Read a specific Alert.
    3. \n
" }, { "name" : "Alert", "description" : "The Auvik Alert API allows you to dismiss an alert that Auvik has triggered.
\n
\nThere is a single endpoint availble within the Alert API.\n
    \n
  1. Dismiss Alert. Dismiss a single alert.
    2. \n
" }, { "name" : "Usage", "description" : "The Auvik Usage API allows to view usage data that Auvik uses to calculate your invoices.
\n
\nThere are two endpoints available in the Usage API.\n
    \n
  1. Read Client Usage Read a summary of a client’s (and client’s children if a multi-client) usage for a given time range.
    2. \n
  2. Read Device Usage Read the usage data of a device for a given period.
    3. \n
" }, { "name" : "Statistics", "description" : "The Auvik Statistics API allows you view some of the entity statistics that Auvik monitors.
\n
\nThere are six endpoints available in the Statistics API.\n
    \n
  1. Read Device Statistics: Provides historical device statistics such as bandwidth, CPU utilization and memory utilization.
    2. \n
  2. Read Device Availability Statistics: Provides historical device uptime and outage statistics.
    3. \n
  3. Read Service Statistics: Provides historical cloud ping check statistics.
    4. \n
  4. Read Interface Statistics: Provides historical interface statistics such as bandwidth and packet loss.
    5. \n
  5. Read Component Statistics: Provides historical statistics for components such as CPUs, disks, fans and memory.
    6. \n
  6. Read OID Statistics: Provides the current value for numeric SNMP Pollers.
    7. \n
" }, { "name" : "SNMP Poller", "description" : "The Auvik SNMP Poller API allows to view SNMP Poller Settings configured in Auvik.
\n
\nThere are three endpoints available in the SNMP Poller API.\n
    \n
  1. Read Multiple SNMP Poller Settings: Provides details about multiple SNMP Poller Settings.
    2. \n
  2. Read Single SNMP Poller Settings: Provides details about a specific SNMP Poller Setting.
    3. \n
  3. Read SNMP Poller Setting's Devices: Provides details about all the devices associated to a specific SNMP Poller Setting.
    4. \n
" }, { "name" : "SNMP Poller History", "description" : "The Auvik SNMP Poller History API allows to view the history of the device's statistics that Auvik polls.
\n
\nThere are two endpoints available in the SNMP Poller History API.\n
    \n
  1. Read String SNMP Poller Setting History: Provides historical values of String SNMP Poller Settings.
    2. \n
  2. Read Numeric SNMP Poller Setting History: Provides historical values of Numeric SNMP Poller Settings.
    3. \n
" }, { "name" : "ASM", "description" : "The Auvik SaaS Management API allows you to access all SaaS related data collected via the Auvik SaaS Management product. The Auvik SaaS Management API includes all core data included as a part of the product including Applications, Monitored Users, Security Logs, and other key data." } ], "paths" : { "/authentication/verify" : { "get" : { "tags" : [ "Credentials" ], "summary" : "Verify Credentials", "description" : "Use the Verify Credentials API to verify your credentials are correct before making a call to an endpoint.
\n
\nLooking 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:\n", "operationId" : "verifyCredentials", "responses" : { "200" : { "description" : "Your credentials are valid.", "content" : { } }, "401" : { "description" : "Your credentials are invalid.", "content" : { } } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/authentication/verify'" } ] } }, "/inventory/device/info" : { "get" : { "tags" : [ "Device" ], "summary" : "Read Multiple Devices’ Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleDeviceInfo", "parameters" : [ { "name" : "filter[networks]", "in" : "query", "description" : "Filter by IDs of networks this device is on.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[makeModel]", "in" : "query", "description" : "Filter by the device’s make and model.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"M Series Access Point\"" }, { "name" : "filter[vendorName]", "in" : "query", "description" : "Filter by the device’s vendor/manufacturer.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Ubiquiti" }, { "name" : "filter[onlineStatus]", "in" : "query", "description" : "Filter by the device’s online status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ] }, "example" : "online" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[notSeenSince]", "in" : "query", "description" : "Filter by the last seen online time, returning entities not seen online after the provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-11-30T18:34:42.652Z" }, { "name" : "filter[stateKnown]", "in" : "query", "description" : "Filter by devices with recently updated data, for more consistent results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" }, { "name" : "include", "in" : "query", "description" : "Use to include the full resource objects of the list device relationships.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "deviceDetail" ] }, "example" : "deviceDetail" }, { "name" : "fields[deviceDetail]", "in" : "query", "description" : "Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=deviceDetail", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "discoveryStatus", "components", "connectedDevices", "configurations", "manageStatus", "interfaces" ] }, "example" : "discoveryStatus,components" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceInfoReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?filter[deviceType]=router&tenants=195798545063742726&include=deviceDetail'" } ] } }, "/inventory/device/info/{id}" : { "get" : { "tags" : [ "Device" ], "summary" : "Read a Single Device’s Info", "description" : "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.
\n
\nTo find the device IDs, run the Read Multiple Devices API.
\n
\nLooking 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:\n", "operationId" : "readSingleDeviceInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Use to include the full resource objects of the list device relationships.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "deviceDetail" ] }, "example" : "deviceDetail" }, { "name" : "fields[deviceDetail]", "in" : "query", "description" : "Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=deviceDetail", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "discoveryStatus", "components", "connectedDevices", "configurations", "manageStatus", "interfaces" ] }, "example" : "discoveryStatus,components" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceInfoReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/device/detail" : { "get" : { "tags" : [ "Device" ], "summary" : "Read Multiple Devices’ Details", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleDeviceDetails", "parameters" : [ { "name" : "filter[manageStatus]", "in" : "query", "description" : "Filter by managed status", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "filter[discoverySNMP]", "in" : "query", "description" : "Filter by the device’s SNMP discovery status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "example" : "disabled" }, { "name" : "filter[discoveryWMI]", "in" : "query", "description" : "Filter by the device’s WMI discovery status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "example" : "disabled" }, { "name" : "filter[discoveryLogin]", "in" : "query", "description" : "Filter by the device’s Login discovery status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "example" : "disabled" }, { "name" : "filter[discoveryVMware]", "in" : "query", "description" : "Filter by the device’s VMware discovery status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "example" : "disabled" }, { "name" : "filter[trafficInsightsStatus]", "in" : "query", "description" : "Filter by the device’s TrafficInsights status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "notDetected", "detected", "notApproved", "approved", "linking", "linkingFailed", "forwarding" ] }, "example" : "approved" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceDetailsReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?tenants=195798545063742726'" } ] } }, "/inventory/device/detail/{id}" : { "get" : { "tags" : [ "Device" ], "summary" : "Read a Single Device’s Details", "description" : "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.
\n
\nTo find the device IDs, run the Read Multiple Devices API.
\n
\nLooking 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:\n", "operationId" : "readSingleDeviceDetails", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceDetailsReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/device/detail/extended" : { "get" : { "tags" : [ "Device" ], "summary" : "Read Multiple Devices’ Extended Details", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleDeviceExtendedDetail", "parameters" : [ { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : true, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[notSeenSince]", "in" : "query", "description" : "Filter by the last seen online time, returning entities not seen online after the provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-11-30T18:34:42.652Z" }, { "name" : "filter[stateKnown]", "in" : "query", "description" : "Filter by devices with recently updated data, for more consistent results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceDetailsExtendedReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?filter[deviceType]=switch&tenants=195798545063742726'" } ] } }, "/inventory/device/detail/extended/{id}" : { "get" : { "tags" : [ "Device" ], "summary" : "Read a Single Device’s Extended Details", "description" : "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.
\n
\nTo find the device IDs, run the Read Multiple Devices API.
\n
\nLooking 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:\n", "operationId" : "readSingleDeviceExtendedDetail", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceDetailsExtendedReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/device/warranty" : { "get" : { "tags" : [ "Device" ], "summary" : "Read Multiple Devices’ Warranty Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleDeviceWarranty", "parameters" : [ { "name" : "filter[coveredUnderWarranty]", "in" : "query", "description" : "Filter by warranty coverage status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "filter[coveredUnderService]", "in" : "query", "description" : "Filter by service coverage status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceWarrantyReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?filter[coveredUnderWarranty]=true&tenants=195798545063742726'" } ] } }, "/inventory/device/warranty/{id}" : { "get" : { "tags" : [ "Device" ], "summary" : "Read a Single Device’s Warranty Info", "description" : "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.
\n
\nTo find the device IDs, run the Read Multiple Devices API.
\n
\nLooking 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:\n", "operationId" : "readSingleDeviceWarranty", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceWarrantyReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/device/lifecycle" : { "get" : { "tags" : [ "Device" ], "summary" : "Read Multiple Devices’ Lifecycle Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleDeviceLifecycle", "parameters" : [ { "name" : "filter[salesAvailability]", "in" : "query", "description" : "Filter by sales availability.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ] }, "example" : "available" }, { "name" : "filter[softwareMaintenanceStatus]", "in" : "query", "description" : "Filter by software maintenance status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ] }, "example" : "available" }, { "name" : "filter[securitySoftwareMaintenanceStatus]", "in" : "query", "description" : "Filter by security software maintenance status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ] }, "example" : "available" }, { "name" : "filter[lastSupportStatus]", "in" : "query", "description" : "Filter by last support status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ] }, "example" : "available" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceLifecycleReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?filter[salesAvailability]=available&tenants=195798545063742726'" } ] } }, "/inventory/device/lifecycle/{id}" : { "get" : { "tags" : [ "Device" ], "summary" : "Read a Single Device’s Lifecycle Info", "description" : "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.
\n
\nTo find the device IDs, run the Read Multiple Devices API.
\n
\nLooking 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:\n", "operationId" : "readSingleDeviceLifecycle", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceLifecycleReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/configuration" : { "get" : { "tags" : [ "Configuration" ], "summary" : "Read Multiple Device Configurations", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleConfigurations", "parameters" : [ { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[backupTimeAfter]", "in" : "query", "description" : "Filter by date and time, filtering out configurations backed up before value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[backupTimeBefore]", "in" : "query", "description" : "Filter by date and time, filtering out configurations backed up after value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[isRunning]", "in" : "query", "description" : "Filter for configurations that are currently running, or filter for all configurations which are not currently running.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/configReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?tenants=195798545063742726'" } ] } }, "/inventory/configuration/{id}" : { "get" : { "tags" : [ "Configuration" ], "summary" : "Read a Single Device Configuration", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readSingleConfiguration", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of configuration", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/configReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/network/info" : { "get" : { "tags" : [ "Network" ], "summary" : "Read Multiple Networks’ Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleNetworkInfo", "parameters" : [ { "name" : "filter[networkType]", "in" : "query", "description" : "Filter by network type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "routed", "vlan", "wifi", "loopback", "network", "layer2", "internet" ] }, "example" : "routed" }, { "name" : "filter[scanStatus]", "in" : "query", "description" : "Filter by the network’s scan status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "true", "false", "notAllowed", "unknown" ] }, "example" : "true" }, { "name" : "filter[devices]", "in" : "query", "description" : "Filter by IDs of devices on this network. Filter by multiple values by providing a comma delimited list.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" }, { "name" : "include", "in" : "query", "description" : "Use to include the full resource objects of any of the network’s relationships.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "networkDetail" ] }, "example" : "networkDetail" }, { "name" : "fields[networkDetail]", "in" : "query", "description" : "Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=networkDetail", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "scope", "primaryCollector", "secondaryCollectors", "collectorSelection", "excludedIpAddresses" ] }, "example" : "scope,excludedIpAddresses" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/networkInfoReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?filter[networkType]=routed&tenants=195798545063742726&include=networkDetail'" } ] } }, "/inventory/network/info/{id}" : { "get" : { "tags" : [ "Network" ], "summary" : "Read a Single Network’s Info", "description" : "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.
\n
\nTo find the network IDs, run the Read Multiple Networks’ Info API.
\n
\nLooking 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:\n", "operationId" : "readSingleNetworkInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of network", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "include", "in" : "query", "description" : "Use to include the full resource objects of any of the network’s relationships.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "networkDetail" ] }, "example" : "networkDetail" }, { "name" : "fields[networkDetail]", "in" : "query", "description" : "Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=networkDetail", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "scope", "primaryCollector", "secondaryCollectors", "collectorSelection", "excludedIpAddresses" ] }, "example" : "scope,excludedIpAddresses" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/networkInfoReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'" } ] } }, "/inventory/network/detail" : { "get" : { "tags" : [ "Network" ], "summary" : "Read Multiple Networks’ Details", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleNetworkDetails", "parameters" : [ { "name" : "filter[networkType]", "in" : "query", "description" : "Filter by network type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "routed", "vlan", "wifi", "loopback", "network", "layer2", "internet" ] }, "example" : "routed" }, { "name" : "filter[scanStatus]", "in" : "query", "description" : "Filter by the network’s scan status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "true", "false", "notAllowed", "unknown" ] }, "example" : "true" }, { "name" : "filter[devices]", "in" : "query", "description" : "Filter by IDs of devices on this network. Filter by multiple values by providing a comma delimited list.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[scope]", "in" : "query", "description" : "Filter by the network’s scope", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "private", "public" ] }, "example" : "private" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/networkDetailsReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?tenants=195798545063742726'" } ] } }, "/inventory/network/detail/{id}" : { "get" : { "tags" : [ "Network" ], "summary" : "Read a Single Network’s Details", "description" : "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.
\n
\nTo find the network IDs, run the Read Multiple Networks API.
\n
\nLooking 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:\n", "operationId" : "readSingleNetworkDetails", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of network", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/networkDetailsReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/interface/info" : { "get" : { "tags" : [ "Interface" ], "summary" : "Read Multiple Interfaces Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleInterfaceInfo", "parameters" : [ { "name" : "filter[interfaceType]", "in" : "query", "description" : "Filter by interface type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ethernet", "wifi", "bluetooth", "cdma", "coax", "cpu", "distributedVirtualSwitch", "firewire", "gsm", "ieee8023AdLag", "inferredWired", "inferredWireless", "interface", "linkAggregation", "loopback", "modem", "wimax", "optical", "other", "parallel", "ppp", "radiomac", "rs232", "tunnel", "unknown", "usb", "virtualBridge", "virtualNic", "virtualSwitch", "vlan" ] }, "example" : "ethernet" }, { "name" : "filter[parentDevice]", "in" : "query", "description" : "Filter by the entity's parent device ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA" }, { "name" : "filter[adminStatus]", "in" : "query", "description" : "Filter by the interface’s admin status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "filter[operationalStatus]", "in" : "query", "description" : "Filter by the interface’s operational status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ] }, "example" : "online" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/interfaceInfoReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?filter[interfaceType]=ethernet&tenants=195798545063742726'" } ] } }, "/inventory/interface/info/{id}" : { "get" : { "tags" : [ "Interface" ], "summary" : "Read a Single Interfaces Info", "description" : "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.
\n
\nTo find the interface IDs, run the Read Multiple Interfaces Info API.
\n
\nLooking 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:\n", "operationId" : "readSingleInterfaceInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of interface", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/interfaceInfoReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/inventory/component/info" : { "get" : { "tags" : [ "Component" ], "summary" : "Read Multiple Components’ Info", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleComponentInfo", "parameters" : [ { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by the component’s parent device’s ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[deviceName]", "in" : "query", "description" : "Filter by the component’s parent device’s name.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"ESXi-H153.MSC.MGMT\"" }, { "name" : "filter[currentStatus]", "in" : "query", "description" : "Filter by the component’s current status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ok", "degraded", "failed" ] }, "example" : "ok" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/componentInfoReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?filter[currentStatus]=degraded&tenants=195798545063742726'" } ] } }, "/inventory/component/info/{id}" : { "get" : { "tags" : [ "Component" ], "summary" : "Read a Single Component’s Info", "description" : "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.
\n
\nTo find the component IDs, run the Read Multiple Components’ Info API.
\n
\nLooking 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:\n", "operationId" : "readSingleComponentInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of component", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/componentInfoReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'" } ] } }, "/inventory/entity/note" : { "get" : { "tags" : [ "Entity" ], "summary" : "Read Multiple Entity Notes", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleEntityNote", "parameters" : [ { "name" : "filter[entityId]", "in" : "query", "description" : "Filter by the entity’s ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, { "name" : "filter[entityType]", "in" : "query", "description" : "Filter by the entity’s type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "root", "device", "network", "interface" ] }, "example" : "network" }, { "name" : "filter[entityName]", "in" : "query", "description" : "Filter by the entity’s name.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"192.168.4.0/24\"" }, { "name" : "filter[lastModifiedBy]", "in" : "query", "description" : "Filter by the user the note was last modified by.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"John User\"" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/entityNotesReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?filter[entityType]=device&tenants=195798545063742726'" } ] } }, "/inventory/entity/note/{id}" : { "get" : { "tags" : [ "Entity" ], "summary" : "Read a Single Entity Note", "description" : "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.
\n
\nTo find the note IDs the Read Multiple Entity Notes API.
\n
\nLooking 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:\n", "operationId" : "readSingleEntityNote", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of entity note", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/entityNotesReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'" } ] } }, "/inventory/entity/audit" : { "get" : { "tags" : [ "Entity" ], "summary" : "Read Multiple Entity Audits", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleEntityAudit", "parameters" : [ { "name" : "filter[user]", "in" : "query", "description" : "Filter by user name associated to the audit.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"John Smith\"" }, { "name" : "filter[category]", "in" : "query", "description" : "Filter by the audit’s category.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "unknown", "tunnel", "terminal", "remoteBrowser" ] }, "example" : "unknown" }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by the audit’s status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "unknown", "initiated", "created", "closed", "failed" ] }, "example" : "created" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/entityAuditReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?filter[status]=created&tenants=195798545063742726'" } ] } }, "/inventory/entity/audit/{id}" : { "get" : { "tags" : [ "Entity" ], "summary" : "Read a Single Entity Audit", "description" : "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.
\n
\nTo find the audit ID, run the Read Multiple Entity Audits API
\n
\nLooking 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:\n", "operationId" : "readSingleEntityAudit", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of entity audit", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/entityAuditReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw'" } ] } }, "/tenants" : { "get" : { "tags" : [ "Tenants" ], "summary" : "Read Multiple Tenants", "description" : "Use the Read Multiple Tenants API to pull access detail about multiple multi-clients and clients associated with your Auvik user account.
\n
\n 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:\n ", "operationId" : "readMultipleTenants", "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/userTenantsReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants'" } ] } }, "/tenants/detail" : { "get" : { "tags" : [ "Tenants" ], "summary" : "Read Multiple Tenants Detail", "description" : "Use the Read Multiple Tenants API to pull details for multiple multi-clients and clients associated with your main Auvik account.
\n
\n 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:\n ", "operationId" : "readMultipleTenantsDetail", "parameters" : [ { "name" : "tenantDomainPrefix", "in" : "query", "description" : "Domain prefix of your main Auvik account (tenant).", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "mspdemo" }, { "name" : "filter[availableTenants]", "in" : "query", "description" : "Filter whether or not a tenant is available, i.e. data can be gotten from them via the API.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/tenantsDetailReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants/detail?tenantDomainPrefix=mspdemo'" } ] } }, "/tenants/detail/{id}" : { "get" : { "tags" : [ "Tenants" ], "summary" : "Read Single Tenant Detail", "description" : "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.
\n
\n You can find the tenant ID for the multi-client or client by Read Multiple Tenants Detail.
\n
\n 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:\n ", "operationId" : "readSingleTenantsDetail", "parameters" : [ { "name" : "tenantDomainPrefix", "in" : "query", "description" : "Domain prefix of your main Auvik account (tenant).", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "mspdemo" }, { "name" : "id", "in" : "path", "description" : "ID of tenant", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/tenantsDetailReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/tenants/detail/322018492519875477?tenantDomainPrefix=mspdemo'" } ] } }, "/alert/history/info" : { "get" : { "tags" : [ "Alert History" ], "summary" : "Read Multiple Alerts’ Info", "description" : "Use the Read Multiple Alerts’ Info API to pull the collected information about the various alerts that Auvik has triggered.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\n
\nLooking 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:\n", "operationId" : "readMultipleAlertInfo", "parameters" : [ { "name" : "filter[alertDefinitionId]", "in" : "query", "description" : "Filter by alert definition ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo" }, { "name" : "filter[alertSpecificationId]", "in" : "query", "description" : "Filter by alert specification ID. Use 'alertDefinitionId' instead", "required" : false, "deprecated" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "-100" }, { "name" : "filter[severity]", "in" : "query", "description" : "Filter by alert severity.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "unknown", "emergency", "critical", "warning", "info" ] }, "example" : "warning" }, { "name" : "filter[status]", "in" : "query", "description" : "Filter by the status of the alert.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "created", "resolved", "paused", "unpaused" ] }, "example" : "created" }, { "name" : "filter[entityId]", "in" : "query", "description" : "Filter by the related entity ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA" }, { "name" : "filter[dismissed]", "in" : "query", "description" : "Filter by the dismissed status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "false" }, { "name" : "filter[dispatched]", "in" : "query", "description" : "Filter by dispatched status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "false" }, { "name" : "filter[detectedTimeAfter]", "in" : "query", "description" : "Filter by the time which is greater than the given timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "2018-11-21T20:56:38.922Z" }, { "name" : "filter[detectedTimeBefore]", "in" : "query", "description" : "Filter by the time which is less than or equal to the given timestamp.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "2018-11-30T18:34:42.652Z" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/alertHistoryInfoReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/history/info?tenants=382911061747041209&filter[dismissed]=true'" } ] } }, "/alert/history/info/{id}" : { "get" : { "tags" : [ "Alert History" ], "summary" : "Read a Single Alert’s Info", "description" : "Use the Read Single Alert’s Info API to pull the collected information about a specific alert that Auvik has triggered.
\n
\nTo find the alert IDs, run the Read Multiple Alerts API.
\n
\nLooking 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:\n", "operationId" : "readSingleAlertInfo", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of alert", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/alertHistoryInfoReadSingle" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/alert/dismiss/{id}" : { "post" : { "tags" : [ "Alert" ], "summary" : "Dismiss an alert", "description" : "Use the Dismiss Alert API to dismiss a specific alert that Auvik has triggered", "operationId" : "alertDismissSingle", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of alert", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } } ], "responses" : { "200" : { "description" : "Successful operation" }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -X POST -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/alert/dismiss/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/billing/usage/client" : { "get" : { "tags" : [ "Usage" ], "summary" : "Read Client Usage", "description" : "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.
\n
\nTo find the client IDs, run the Read Multiple Tenants API.
\nLooking 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:\n", "operationId" : "readClientUsage", "parameters" : [ { "name" : "filter[fromDate]", "in" : "query", "description" : "Date from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-01" }, { "name" : "filter[thruDate]", "in" : "query", "description" : "Date to which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-30" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/clientUsageRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168516&filter[fromDate]=2019-06-01&filter[thruDate]=2019-06-30'" } ] } }, "/billing/usage/device/{id}" : { "get" : { "tags" : [ "Usage" ], "summary" : "Read Device Usage", "description" : "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.
\nLooking 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:\n", "operationId" : "readDeviceUsage", "parameters" : [ { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, { "name" : "filter[fromDate]", "in" : "query", "description" : "Date from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-01" }, { "name" : "filter[thruDate]", "in" : "query", "description" : "Date to which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-30" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceUsageRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?filter[fromDate]=2019-06-01&filter[thruDate]=2019-06-30'" } ] } }, "/stat/device/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read Device Statistics", "description" : "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.
\nLooking 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:\n", "operationId" : "readDeviceStatistics", "parameters" : [ { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "bandwidth", "cpuUtilization", "memoryUtilization", "storageUtilization", "packetUnicast", "packetMulticast", "packetBroadcast" ] } }, { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceStatisticsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com: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'" } ] } }, "/stat/deviceAvailability/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read Device Availability Statistics", "description" : "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.
\nLooking 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:\n", "operationId" : "readDeviceAvailabilityStatistics", "parameters" : [ { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "uptime", "outage" ] } }, { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceAvailabilityStatisticsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com: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'" } ] } }, "/stat/service/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read Service Statistics", "description" : "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.
\nLooking 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:\n", "operationId" : "readServiceStatistics", "parameters" : [ { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "pingTime", "pingPacket" ] } }, { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "filter[serviceId]", "in" : "query", "description" : "Filter by service ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "NzkyMywtMjAwMDAwMCxzdGF0L3NlcnZpY2UvcGluZ1RpbWU6aG91cg" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/serviceStatisticsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com: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'" } ] } }, "/stat/interface/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read Interface Statistics", "description" : "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.
\nLooking 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:\n", "operationId" : "readInterfaceStatistics", "parameters" : [ { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "bandwidth", "utilization", "packetLoss", "packetDiscard", "packetMulticast", "packetUnicast", "packetBroadcast" ] } }, { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "filter[interfaceType]", "in" : "query", "description" : "Filter by interface type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ethernet", "wifi", "bluetooth", "cdma", "coax", "cpu", "distributedVirtualSwitch", "firewire", "gsm", "ieee8023AdLag", "inferredWired", "inferredWireless", "interface", "linkAggregation", "loopback", "modem", "wimax", "optical", "other", "parallel", "ppp", "radiomac", "rs232", "tunnel", "unknown", "usb", "virtualBridge", "virtualNic", "virtualSwitch", "vlan" ] }, "example" : "ethernet" }, { "name" : "filter[interfaceId]", "in" : "query", "description" : "Filter by interface ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, { "name" : "filter[parentDevice]", "in" : "query", "description" : "Filter by the entity's parent device ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/interfaceStatisticsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com: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'" } ] } }, "/stat/component/{componentType}/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read Component Statistics", "description" : "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.
\nLooking 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:\nEach component type specified in the query path supports reporting statistics as indicated below:
componentTypestatId
cpu
  • capacity
  • latency
  • readiness
  • ready
  • swap
cpuCore
  • idle
  • utilization
disk
  • latency
  • queueLatency
  • rate
  • totalLatency
fan
  • speed
memory
  • counters
  • swap
  • swapRate
  • temperature
powerSupply
  • power
systemBoard
  • temperature
", "operationId" : "readComponentStatistics", "parameters" : [ { "name" : "componentType", "in" : "path", "description" : "Component type of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "cpu", "cpuCore", "disk", "fan", "memory", "powerSupply", "systemBoard" ] } }, { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "capacity", "counters", "idle", "latency", "power", "queueLatency", "rate", "readiness", "ready", "speed", "swap", "swapRate", "temperature", "totalLatency", "utilization" ] } }, { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "filter[componentId]", "in" : "query", "description" : "Filter by component ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, { "name" : "filter[parentDevice]", "in" : "query", "description" : "Filter by the entity's parent device ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/componentStatisticsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com: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'" } ] } }, "/stat/oid/{statId}" : { "get" : { "tags" : [ "Statistics" ], "summary" : "Read OID Statistics", "description" : "Use the Read OID Statistics API to fetch the last recorded value of a monitored device OID.
\nLooking 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:\n", "operationId" : "readOidStatistics", "parameters" : [ { "name" : "statId", "in" : "path", "description" : "ID of statistic to return", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string", "enum" : [ "deviceMonitor" ] } }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[oid]", "in" : "query", "description" : "Filter by OID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "1.3.6.1.2.1.1.3" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/deviceOidMonitorRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/oid/deviceMonitor'" } ] } }, "/settings/snmppoller" : { "get" : { "tags" : [ "SNMP Poller" ], "summary" : "Read Multiple SNMP Poller Settings", "description" : "Use the Read Multiple SNMP Poller Settings API to pull the list of SNMP Poller Settings configured in Auvik.
\n
\nLooking 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:\n", "operationId" : "readMultipleSnmpPollerSettings", "parameters" : [ { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[useAs]", "in" : "query", "description" : "Filter by oid type", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "serialNo", "poller" ] }, "example" : "poller" }, { "name" : "filter[type]", "in" : "query", "description" : "Filter by type", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "string", "numeric" ] }, "example" : "numeric" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[makeModel]", "in" : "query", "description" : "Filter by the device’s make and model.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "M%22Series%20Access%20PointM%22" }, { "name" : "filter[vendorName]", "in" : "query", "description" : "Filter by the device’s vendor/manufacturer.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Ubiquiti" }, { "name" : "filter[oid]", "in" : "query", "description" : "Filter by OID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "1.3.6.1.2.1.1.3" }, { "name" : "filter[name]", "in" : "query", "description" : "Filter by the name of the SNMP poller setting", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "M%22SteveM%22" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/snmpPollerSettingsRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller'" } ] } }, "/settings/snmppoller/{snmpPollerSettingId}" : { "get" : { "tags" : [ "SNMP Poller" ], "summary" : "Read Single SNMP Poller Setting", "description" : "Use the Read Single SNMP Poller Setting API to pull details of a specific SNMP Poller Setting configured in Auvik.
\n
\nLooking 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:\n", "operationId" : "readSnmpPollerSettingSingle", "parameters" : [ { "name" : "snmpPollerSettingId", "in" : "path", "description" : "ID of the SNMP Poller Setting to retrieve", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/snmpPollerSettingSingleRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw'" } ] } }, "/settings/snmppoller/{snmpPollerSettingId}/devices" : { "get" : { "tags" : [ "SNMP Poller" ], "summary" : "Read SNMP Poller Setting's Devices", "description" : "Use Read SNMP Poller Setting's Devices API to pull the list of devices that apply to a specific SNMP Poller Setting Id.
\n
\nLooking 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:\n", "operationId" : "ReadMultipleSnmpPollerSettingDevices", "parameters" : [ { "name" : "snmpPollerSettingId", "in" : "path", "description" : "ID of the SNMP Poller Setting that the devices apply to", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "filter[onlineStatus]", "in" : "query", "description" : "Filter by the device’s online status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ] }, "example" : "online" }, { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, { "name" : "filter[notSeenSince]", "in" : "query", "description" : "Filter by the last seen online time, returning entities not seen online after the provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-11-30T18:34:42.652Z" }, { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, { "name" : "filter[makeModel]", "in" : "query", "description" : "Filter by the device’s make and model.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "\"M Series Access Point\"" }, { "name" : "filter[vendorName]", "in" : "query", "description" : "Filter by the device’s vendor/manufacturer.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Ubiquiti" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/snmpPollerSettingDevicesRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices'" } ] } }, "/stat/snmppoller/string" : { "get" : { "tags" : [ "SNMP Poller History" ], "summary" : "Read String SNMP Poller Setting's History", "description" : "Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting.
\n
\nLooking 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:\n", "operationId" : "ReadMultipleSnmpPollerSettingStringHistory", "parameters" : [ { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2022-03-10 01:00:00" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2022-03-10 09:00:00" }, { "name" : "filter[compact]", "in" : "query", "description" : "Whether to show compact view of the results or not. Compact view only shows changes in value. If compact view is false, dateTime range can be a maximum of 24h", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" }, "example" : "true" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[snmpPollerSettingId]", "in" : "query", "description" : "Comma delimited list of SNMP poller setting IDs to request info from. Note this is internal snmpPollerSettingId. The user can get the list of IDs for a specific poller using the GET /settings/snmppoller endpoint.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE,Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string'" } ] } }, "/stat/snmppoller/int" : { "get" : { "tags" : [ "SNMP Poller History" ], "summary" : "Read Numeric SNMP Poller Setting's History", "description" : "Use the Read SNMP Poller Setting's History API to fetch the list of historical vaules for a SNMP Poller Setting.
\n
\nLooking 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:\n", "operationId" : "ReadMultipleSnmpPollerSettingIntHistory", "parameters" : [ { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2022-03-10 01:00:00" }, { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2022-03-10 09:00:00" }, { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" }, { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, { "name" : "filter[snmpPollerSettingId]", "in" : "query", "description" : "Comma delimited list of SNMP poller setting IDs to request info from. Note this is internal snmpPollerSettingId. The user can get the list of IDs for a specific poller using the GET /settings/snmppoller endpoint.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE,Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/snmpPollerIntHistoryRead" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int'" } ] } }, "/asm/app/info" : { "get" : { "tags" : [ "ASM" ], "summary" : "Read Multiple ASM Applications' Info", "description" : "Use the Read Multiple ASM Applications' Info to retrieve the information related to the SaaS applications discovered within an ASM client deployment. This data includes the number of users of an application as well as key metadata such as whether the application is approved or unapproved.", "operationId" : "ReadMultipleASMAppInfo", "parameters" : [ { "name" : "filter[clientId]", "in" : "query", "description" : "Filter by client ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "a09a70dc-7070-498d-b7fd-ab37a81185c5" }, { "name" : "filter[dateAddedBefore]", "in" : "query", "description" : "Return applications added before this date", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "filter[dateAddedAfter]", "in" : "query", "description" : "Return applications added after this date", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "filter[queryDate]", "in" : "query", "description" : "Return associated breaches added after this date", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "filter[user_lastUsedAfter]", "in" : "query", "description" : "Return associated users added after this date", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "filter[user_lastUsedBefore]", "in" : "query", "description" : "Return associated users before this date", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "include", "in" : "query", "description" : "Use to include extended details of the application or of its related objects.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "all", "breaches", "users", "contracts", "publisher", "accessData" ] }, "example" : "users,contracts" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/appReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/asm/app/info?filter[clientId]=a09a70dc-7070-498d-b7fd-ab37a81185c5'" } ] } }, "/asm/client/info" : { "get" : { "tags" : [ "ASM" ], "summary" : "Read Multiple ASM Clients' Info", "description" : "The Read Multiple ASM Clients' Info API returns relevant meta data about clients that exist within the Auvik SaaS Management product. The response includes the number of total users as well as clientIDs which may be used to filter other relevant API calls.", "operationId" : "ReadMultipleASMClientInfo", "parameters" : [ { "name" : "include", "in" : "query", "description" : "Use to include extended details of the client.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "totals" ] }, "example" : "totals" }, { "name" : "filter[queryDate]", "in" : "query", "description" : "Only count breaches added after this date. Only useful when include=totals is set.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/clientReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/asm/client/info'" } ] } }, "/asm/securityLog/info" : { "get" : { "tags" : [ "ASM" ], "summary" : "Read Multiple ASM Security Logs' Info", "description" : "Use the Read Multiple ASM Security Logs' Info API to retrieve in depth information about the security logs within an Auvik SaaS Management client. Security logs include specific SaaS events, such as logins or downloads with timestamps for each event.", "operationId" : "ReadMultipleASMSecurityLogInfo", "parameters" : [ { "name" : "filter[clientId]", "in" : "query", "description" : "Filter by client ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "a09a70dc-7070-498d-b7fd-ab37a81185c5" }, { "name" : "include", "in" : "query", "description" : "Use to include extended details of the security log or of its related objects.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "users", "applications" ] }, "example" : "users,contracts" }, { "name" : "filter[queryDate]", "in" : "query", "description" : "Only return security logs added after this date.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2024-10-10T05:43:26.386Z" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/securityLogReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/asm/securityLog/info?filter[clientId]=a09a70dc-7070-498d-b7fd-ab37a81185c5'" } ] } }, "/asm/tag/info" : { "get" : { "tags" : [ "ASM" ], "summary" : "Read Multiple ASM Tags' Info", "description" : "Use the Read Multiple ASM Tags' Info API to retrieve information about tags configured within an ASM client.", "operationId" : "ReadMultipleASMTagInfo", "parameters" : [ { "name" : "filter[clientId]", "in" : "query", "description" : "Filter by client ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "a09a70dc-7070-498d-b7fd-ab37a81185c5" }, { "name" : "filter[applicationId]", "in" : "query", "description" : "Filter by application ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "70750b2d-66e8-483f-9709-dff848080232" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/tagReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/asm/tag/info?filter[clientId]=a09a70dc-7070-498d-b7fd-ab37a81185c5'" } ] } }, "/asm/user/info" : { "get" : { "tags" : [ "ASM" ], "summary" : "Read Multiple ASM Users' Info", "description" : "Use the Read Multiple ASM Users' Info API to retrieve information about any monitored users that exist within a specific Auvik SaaS Management tenant. ASM user data includes core information about the SaaS applications a monitored user is using as well as which accounts a user is leveraging to log into those applications.", "operationId" : "ReadMultipleASMUserInfo", "parameters" : [ { "name" : "filter[clientId]", "in" : "query", "description" : "Filter by client ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "a09a70dc-7070-498d-b7fd-ab37a81185c5" }, { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" } ], "responses" : { "200" : { "description" : "Successful operation", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/userReadMultiple" } } } }, "400" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "403" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "404" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "500" : { "description" : "Something went wrong" } }, "x-code-samples" : [ { "lang" : "cURL", "source" : "curl -u 'user@example.com:apiKey' 'https://auvikapi.us1.my.auvik.com/v1/asm/user/info?filter[clientId]=a09a70dc-7070-498d-b7fd-ab37a81185c5'" } ] } } }, "components" : { "schemas" : { "DeviceTypeSchema" : { "type" : "string", "enum" : [ "unknown", "switch", "l3Switch", "router", "accessPoint", "firewall", "workstation", "server", "storage", "printer", "copier", "hypervisor", "multimedia", "phone", "tablet", "handheld", "virtualAppliance", "bridge", "controller", "hub", "modem", "ups", "module", "loadBalancer", "camera", "telecommunications", "packetProcessor", "chassis", "airConditioner", "virtualMachine", "pdu", "ipPhone", "backhaul", "internetOfThings", "voipSwitch", "stack", "backupDevice", "timeClock", "lightingDevice", "audioVisual", "securityAppliance", "utm", "alarm", "buildingManagement", "ipmi", "thinAccessPoint", "thinClient" ] }, "deviceInfoReadMultiple" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/devicesResourceObject" } }, "included" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceDetailsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/deviceInfoReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "devicesResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "device" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/deviceAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceRelationships" }, "links" : { "$ref" : "#/components/schemas/devicesResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device" }, "deviceAttributes" : { "required" : [ "description", "deviceName", "deviceType", "firmwareVersion", "ipAddresses", "lastModified", "makeModel", "onlineStatus", "serialNumber", "softwareVersion", "vendorName" ], "type" : "object", "properties" : { "ipAddresses" : { "type" : "array", "description" : "Device's local IP addresses", "example" : [ "10.0.0.1" ], "items" : { "type" : "string" }, "x-isRequired" : false, "x-isFilter" : false, "x-label" : "IP Address" }, "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Device Name" }, "deviceType" : { "type" : "string", "description" : "What type of device it is", "example" : "accessPoint", "enum" : [ "unknown", "switch", "l3Switch", "router", "accessPoint", "firewall", "workstation", "server", "storage", "printer", "copier", "hypervisor", "multimedia", "phone", "tablet", "handheld", "virtualAppliance", "bridge", "controller", "hub", "modem", "ups", "module", "loadBalancer", "camera", "telecommunications", "packetProcessor", "chassis", "airConditioner", "virtualMachine", "pdu", "ipPhone", "backhaul", "internetOfThings", "voipSwitch", "stack", "backupDevice", "timeClock", "lightingDevice", "audioVisual", "securityAppliance", "utm", "alarm", "buildingManagement", "ipmi", "thinAccessPoint", "thinClient" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Device Type" }, "makeModel" : { "type" : "string", "description" : "Make and model of this device", "example" : "M Series Access Point", "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Make & Model" }, "vendorName" : { "type" : "string", "description" : "Vendor name for this device", "example" : "Ubiquiti", "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Vendor" }, "softwareVersion" : { "type" : "string", "description" : "Devices software version, if known", "example" : "3.9.3.7537", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Software Version" }, "serialNumber" : { "type" : "string", "description" : "Device's serial number", "example" : "1Q2W3E4R5T6Y", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Serial Number" }, "description" : { "type" : "string", "description" : "Description", "example" : "Linux 3.3.8 #1 Fri Oct 13 11:12:44 PDT 2017 mips", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Description" }, "firmwareVersion" : { "type" : "string", "description" : "Device's firmware version", "example" : "unifi-v1.6.7.249-gb74e0282", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Firmware Version" }, "lastModified" : { "type" : "string", "description" : "When one of this device's attributes was last modified", "example" : "2018-03-12T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Last Modified" }, "lastSeenTime" : { "type" : "string", "description" : "Last seen online date/time of a device", "example" : "2018-11-30T18:34:39.452Z", "x-isFilter" : true, "x-label" : "Last Seen Time" }, "onlineStatus" : { "type" : "string", "description" : "Device's online status", "example" : "online", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Online Status" } }, "additionalProperties" : false, "description" : "The type-specific properties of the devices object returned" }, "deviceRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "networks" : { "$ref" : "#/components/schemas/deviceRelationships_networks" }, "deviceDetail" : { "$ref" : "#/components/schemas/deviceRelationships_deviceDetail" } }, "description" : "This device's relationships to other resources" }, "tenant" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/tenant_data" } }, "description" : "This entity's owning tenant" }, "deviceDetailsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceDetail" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "attributes" : { "$ref" : "#/components/schemas/deviceDetailsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceDetailsRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceDetailsResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device's extra details" }, "deviceDetailsAttributes" : { "required" : [ "discoveryStatus", "manageStatus", "trafficInsightsStatus" ], "type" : "object", "properties" : { "discoveryStatus" : { "$ref" : "#/components/schemas/deviceDetailsAttributes_discoveryStatus" }, "manageStatus" : { "type" : "boolean", "description" : "Whether this device is managed by Auvik or not" }, "trafficInsightsStatus" : { "type" : "string", "description" : "The status of TrafficInsights on this device", "example" : "notDetected", "enum" : [ "notDetected", "detected", "notApproved", "approved", "linking", "linkingFailed", "forwarding" ] } }, "additionalProperties" : false, "description" : "The type-specific properties of the devices object returned" }, "deviceDetailsRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "connectedDevices" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_connectedDevices" }, "interfaces" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_interfaces" }, "configurations" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_configurations" }, "components" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_components" } }, "description" : "This device's relationships to other resources" }, "meta" : { "title" : "meta object", "type" : "object", "properties" : { "totalPages" : { "type" : "number", "description" : "Total page count.", "example" : 5, "deprecated" : true } }, "description" : "The meta object that contains non-standard meta-information" }, "basicError" : { "title" : "JSON API Error Object", "required" : [ "errors" ], "type" : "object", "properties" : { "errors" : { "type" : "array", "description" : "Array of error objects", "items" : { "type" : "object" } } }, "additionalProperties" : false }, "deviceInfoReadSingle" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/devicesResourceObject" }, "included" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceDetailsResourceObject" } } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceDetailsReadMultiple" : { "title" : "root device details object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceDetailsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/deviceDetailsReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceDetailsReadSingle" : { "title" : "root device details object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceDetailsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceDetailsExtendedReadMultiple" : { "title" : "root device details extended object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceExtendedDetailResourceObject" } }, "links" : { "$ref" : "#/components/schemas/deviceDetailsExtendedReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceExtendedDetailResourceObject" : { "oneOf" : [ { "$ref" : "#/components/schemas/stack" }, { "$ref" : "#/components/schemas/hypervisor" }, { "$ref" : "#/components/schemas/controller" }, { "$ref" : "#/components/schemas/accessPoint" }, { "$ref" : "#/components/schemas/miscDevice" } ] }, "stack" : { "description" : "Extended details for a stack", "allOf" : [ { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice" }, { "type" : "object", "properties" : { "attributes" : { "allOf" : [ { "$ref" : "#/components/schemas/baseDeviceExtendedDetailsAttributes" }, { "required" : [ "deviceType" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "stack" ] } } } ] }, "relationships" : { "allOf" : [ { "$ref" : "#/components/schemas/deviceRelationships" }, { "type" : "object", "properties" : { "members" : { "type" : "array", "description" : "Members of this stack", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Device ID of this stack member", "example" : "MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg" }, "type" : { "type" : "string", "description" : "Resource type of this stack member", "example" : "device" }, "attributes" : { "required" : [ "hardwarePriority", "macAddress", "makeModel", "memberName", "memberNumber", "memberRole", "memberStatus", "serialNumber", "softwarePriority", "softwareRevision" ], "type" : "object", "properties" : { "memberName" : { "type" : "string", "description" : "The member's name", "example" : "Stack Member 3" }, "makeModel" : { "type" : "string", "description" : "The member's make and model", "example" : "Extreme Summit X250-48p" }, "memberNumber" : { "type" : "string", "description" : "The member's number in the stack", "example" : "3" }, "memberRole" : { "type" : "string", "description" : "The member's role", "example" : "member", "enum" : [ "master", "member", "notMember", "standby", "backup", "masterOrBackup" ] }, "memberStatus" : { "type" : "string", "description" : "The member's status", "example" : "waiting", "enum" : [ "waiting", "progressing", "added", "ready", "sdmMismatch", "verMismatch", "featureMismatch", "newMasterInit", "provisioned", "invalid", "removed" ] }, "macAddress" : { "type" : "string", "description" : "The member's MAC address", "example" : "1A:2B:3C:4D:5E:6F" }, "softwarePriority" : { "type" : "string", "description" : "Software priority of this stack.", "example" : "1" }, "hardwarePriority" : { "type" : "string", "description" : "Hardware priority of this stack.", "example" : "1" }, "serialNumber" : { "type" : "string", "description" : "The member's serial number", "example" : "123456789" }, "softwareRevision" : { "type" : "string", "description" : "Software revision/version of this stack member", "example" : "1.4.5.02" } }, "description" : "Details about this stack member" }, "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "description" : "Link to this stack member's extended details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg" }, "info" : { "type" : "string", "description" : "Link to this stack member's device info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MzIyMDE4NDkyNTE5OTQxMDEzLDMzMzcwMTk0OTU2MDA5NTEyMg" } }, "description" : "List of links relating to this stack member" } } } } } } ] } } } ] }, "deviceExtendedDetailsDevice" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceExtendedDetail" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "links" : { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device" }, "hypervisor" : { "description" : "Extended details for a hypervisor", "allOf" : [ { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice" }, { "type" : "object", "properties" : { "attributes" : { "allOf" : [ { "$ref" : "#/components/schemas/baseDeviceExtendedDetailsAttributes" }, { "required" : [ "deviceType", "virtualMachines" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "hypervisor" ] }, "virtualMachines" : { "type" : "array", "description" : "List of every VM on this hypervisor", "items" : { "required" : [ "allocatedMemory", "deviceType", "powerStatus", "snapshots", "vCPU", "vDisk" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "virtualMachine" ] }, "powerStatus" : { "type" : "string", "description" : "The VM power status", "example" : "online", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ] }, "vCPU" : { "type" : "string", "description" : "Number of virtual CPUs", "example" : "4" }, "vDisk" : { "type" : "string", "description" : "Number of virtual disks", "example" : "2" }, "allocatedMemory" : { "type" : "string", "description" : "How much memory is allocated to this VM, in Bytes", "example" : "1082130432" }, "snapshots" : { "type" : "array", "description" : "List of image snapshots for this VM", "items" : { "required" : [ "parentSnapshotName", "snapshotDate", "snapshotDescription", "snapshotName", "snapshotSize" ], "type" : "object", "properties" : { "snapshotName" : { "type" : "string", "description" : "The snapshot's name", "example" : "SomeSnapshot" }, "snapshotDescription" : { "type" : "string", "description" : "The snapshot's description", "example" : "This is a snapshot description" }, "snapshotDate" : { "type" : "string", "description" : "The date the snapshot was taken", "example" : "2018-03-12T12:00:00.000Z" }, "snapshotSize" : { "type" : "string", "description" : "File size of the snapshot", "example" : "1.3 GB" }, "parentSnapshotName" : { "type" : "string", "description" : "Parent snapshot's name", "example" : "ParentSnapshot" } } } } } } } } } ] }, "relationships" : { "allOf" : [ { "$ref" : "#/components/schemas/deviceRelationships" } ] } } } ], "x-displayName" : "hypervisor" }, "controller" : { "description" : "Extended details for a controller", "allOf" : [ { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice" }, { "type" : "object", "properties" : { "attributes" : { "allOf" : [ { "$ref" : "#/components/schemas/baseDeviceExtendedDetailsAttributes" }, { "required" : [ "deviceType" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "controller" ] } } } ] }, "relationships" : { "allOf" : [ { "$ref" : "#/components/schemas/deviceRelationships" }, { "type" : "object", "properties" : { "accessPoints" : { "type" : "array", "description" : "List of access points associated to this controller", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The AP's device ID", "example" : "MTk5NzYyMjM1MDE1MTY4MjYwLDE5OTc2MjQ4MzgzMjQ4NzY4Mw" }, "type" : { "type" : "string", "description" : "This access point's device type", "example" : "device" }, "attributes" : { "required" : [ "deviceName" ], "type" : "object", "properties" : { "deviceName" : { "type" : "string", "description" : "The AP's name", "example" : "Some Access Point" } }, "description" : "This access point's attributes" }, "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "description" : "Link to this device's extended details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "info" : { "type" : "string", "description" : "Link to this device's device info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" } } } } } } ] } } } ], "x-displayName" : "controller" }, "accessPoint" : { "description" : "Extended details for an access point", "allOf" : [ { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice" }, { "type" : "object", "properties" : { "attributes" : { "allOf" : [ { "$ref" : "#/components/schemas/baseDeviceExtendedDetailsAttributes" }, { "required" : [ "deviceType", "ssidLists" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "accessPoint" ] }, "ssidList" : { "type" : "array", "description" : "List of the AP's SSIDs", "example" : [ "MyWirelessNetwork" ], "items" : { "type" : "string" } } } } ] }, "relationships" : { "allOf" : [ { "$ref" : "#/components/schemas/deviceRelationships" }, { "type" : "object", "properties" : { "wirelessClients" : { "type" : "array", "description" : "List of wireless clients associated to this controller", "items" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "This wireless client's ID", "example" : "MzQ0NDI0OTkxNzU3OTU5OTA0LDM0NDQyNDk5NjU4MDcyMTM3OA" }, "type" : { "type" : "string", "description" : "Resource type of this wireless client", "example" : "device", "enum" : [ "device" ] }, "attributes" : { "required" : [ "channel", "deviceName", "deviceType", "rssi", "ssid" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "enum" : [ "workstation" ] }, "deviceName" : { "type" : "string", "example" : "Someone's Workstation" }, "ssid" : { "type" : "string", "description" : "The wireless client's SSID", "example" : "MyWirelessNetwork" }, "channel" : { "type" : "string", "description" : "The wireless client's radio channel", "example" : "6" }, "rssi" : { "type" : "string", "description" : "The wireless's clients RSSI", "example" : "notAvailable" } }, "description" : "This wireless client's attributes" }, "links" : { "type" : "object", "properties" : { "self" : { "type" : "string", "description" : "Link to this device's extended details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "info" : { "type" : "string", "description" : "Link to this device's device info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" } } } } } } ] } } } ], "x-displayName" : "accessPoint" }, "miscDevice" : { "description" : "Extended details for a miscellaneous device", "allOf" : [ { "$ref" : "#/components/schemas/deviceExtendedDetailsDevice" }, { "type" : "object", "properties" : { "attributes" : { "allOf" : [ { "$ref" : "#/components/schemas/baseDeviceExtendedDetailsAttributes" }, { "required" : [ "deviceType", "tunnels" ], "type" : "object", "properties" : { "deviceType" : { "type" : "string", "description" : "What type of device it is", "example" : "switch", "enum" : [ "unknown", "switch", "l3Switch", "router", "firewall", "workstation", "server", "storage", "printer", "copier", "multimedia", "phone", "tablet", "handheld", "virtualAppliance", "bridge", "hub", "modem", "ups", "inferredSwitch", "module", "loadBalancer", "camera", "telecommunications", "packetProcessor", "chassis", "airConditioner", "inferredHub", "pdu", "ipPhone", "backhaul", "internetOfThings", "voipSwitch", "backupDevice", "timeClock", "lightingDevice", "audioVisual", "securityAppliance", "utm", "alarm", "buildingManagement", "ipmi", "thinAccessPoint", "thinClient" ] }, "tunnels" : { "type" : "array", "description" : "List of tunnels on the device", "items" : { "required" : [ "destinationBeginIP", "destinationEndIP", "localGateway", "namePhase1", "namePhase2", "remoteGateway", "sourceBeginIP", "sourceEndIP" ], "type" : "object", "properties" : { "namePhase1" : { "type" : "string", "description" : "The defining name of the first phase within Internet Key Exchange (IKE) tunnel negotiation", "example" : "Phase One" }, "namePhase2" : { "type" : "string", "description" : "The defining name of the second phase within Internet Key Exchange (IKE) tunnel negotiation", "example" : "Phase Two" }, "localGateway" : { "type" : "string", "description" : "IP address of the local IKE gateway", "example" : "10.0.0.0" }, "remoteGateway" : { "type" : "string", "description" : "IP address of the remote IKE gateway", "example" : "192.168.0.1" }, "sourceBeginIP" : { "type" : "string", "description" : "The first IP address within the range of addresses assigned to IPSec tunnel interfaces on the local device", "example" : "255.255.255.0" }, "sourceEndIP" : { "type" : "string", "description" : "The last IP address within the range of addresses assigned to IPSec tunnel interfaces on the local device", "example" : "255.255.255.255" }, "destinationBeginIP" : { "type" : "string", "description" : "The first IP address within the range of addresses assigned to IPSec tunnel interfaces on the remote device", "example" : "255.255.255.0" }, "destinationEndIP" : { "type" : "string", "description" : "The last IP address within the range of addresses assigned to IPSec tunnel interfaces on the remote device", "example" : "255.255.255.255" } } } } } } ] }, "relationships" : { "allOf" : [ { "$ref" : "#/components/schemas/deviceRelationships" } ] } } } ], "x-displayName" : "miscDevice" }, "deviceDetailsExtendedReadSingle" : { "title" : "root device details extended object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceExtendedDetailResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceWarrantyReadMultiple" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceWarrantyResourceObject" }, "x-omitempty" : false }, "links" : { "$ref" : "#/components/schemas/deviceWarrantyReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceWarrantyResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceWarranty" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/deviceWarrantyAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceWarrantyRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceWarrantyResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device with warranty information" }, "deviceWarrantyAttributes" : { "required" : [ "deviceName", "recommendedSoftwareVersion", "serviceCoverageStatus", "warrantyCoverageStatus", "warrantyExpirationDate" ], "type" : "object", "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Device Name" }, "serviceCoverageStatus" : { "type" : "string", "description" : "Service coverage status", "example" : "Covered", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Service Coverage Status" }, "serviceAttachmentStatus" : { "type" : "string", "description" : "Service attachment status", "example" : "Available", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Service Attachment Status" }, "contractRenewalAvailability" : { "type" : "string", "description" : "Contract renewal availability", "example" : "Available", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Contract Renewal Availability" }, "warrantyCoverageStatus" : { "type" : "string", "description" : "Warranty coverage status", "example" : "Not Covered", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Warranty Coverage Status" }, "warrantyExpirationDate" : { "type" : "string", "description" : "Warranty expiration date for this device. Value is what is returned by Cisco device, which is not guaranteed to be a date.", "example" : "2015-07-31T00:00:00.000Z", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Warranty End Date" }, "recommendedSoftwareVersion" : { "type" : "string", "description" : "Recommended Devices software version, if known", "example" : "15.1(4)M12a - 06 Oct 2016", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Recommended Firmware Version" } }, "additionalProperties" : false, "description" : "The type-specific properties of the devices object returned" }, "deviceWarrantyRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "This device's relationships to other resources" }, "deviceWarrantyReadSingle" : { "title" : "root device object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceWarrantyResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceLifecycleReadMultiple" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceLifecycleResourceObject" }, "x-omitempty" : false }, "links" : { "$ref" : "#/components/schemas/deviceLifecycleReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceLifecycleResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceLifecycle" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/deviceLifecycleAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceLifecycleResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device with lifecycle information" }, "deviceLifecycleAttributes" : { "required" : [ "deviceName", "lastSupportStatus", "salesAvailability", "securitySoftwareMaintenanceStatus", "softwareMaintenanceStatus" ], "type" : "object", "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Device Name" }, "salesAvailability" : { "type" : "string", "description" : "Availability to order the requested product through Cisco point-of-sale mechanisms", "example" : "available", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Sales Availability" }, "softwareMaintenanceStatus" : { "type" : "string", "description" : "Availability of any software maintenance releases or bug fixes to the software product released by Cisco Engineering", "example" : "available", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Software Maintenance Status" }, "securitySoftwareMaintenanceStatus" : { "type" : "string", "description" : "Availability of any planned maintenance release or scheduled software remedy for a security vulnerability issued by Cisco Engineering", "example" : "available", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Security Software Maintenance Status" }, "lastSupportStatus" : { "type" : "string", "description" : "Availability of service and support for the product", "example" : "available", "enum" : [ "covered", "available", "expired", "securityOnly", "unpublished", "empty" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Last Support Status" } }, "additionalProperties" : false, "description" : "The type-specific properties of the devices object returned" }, "deviceLifecycleRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "device" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships_device" } }, "description" : "This device's relationships to other resources" }, "deviceLifecycleReadSingle" : { "title" : "root device object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceLifecycleResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "configReadMultiple" : { "title" : "root configuration object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/configResourceObject" } }, "links" : { "$ref" : "#/components/schemas/configReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "configResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "configuration" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a configuration", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "attributes" : { "$ref" : "#/components/schemas/configAttributes" }, "relationships" : { "$ref" : "#/components/schemas/configRelationships" }, "links" : { "$ref" : "#/components/schemas/configResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device's configuration" }, "configAttributes" : { "required" : [ "backupTime", "device", "isRunning" ], "type" : "object", "properties" : { "backupTime" : { "type" : "string", "description" : "The time at which this configuration was backed up.", "example" : "2018-03-12T12:00:00.000Z" }, "isRunning" : { "type" : "boolean", "description" : "Whether or not the configuration is currently running on the device.", "example" : true } }, "additionalProperties" : false, "description" : "The type-specific properties of the configuration object returned" }, "configRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "device" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships_device" } }, "description" : "This configurations relationships to other resources" }, "configReadSingle" : { "title" : "root configuration object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/configResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "networkInfoReadMultiple" : { "title" : "root networks object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/networksResourceObject" } }, "included" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/networkDetailsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/networkInfoReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "networksResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "network" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this network", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/networkAttributes" }, "relationships" : { "$ref" : "#/components/schemas/networkRelationships" }, "links" : { "$ref" : "#/components/schemas/networksResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik network" }, "networkAttributes" : { "required" : [ "description", "lastModified", "networkName", "networkType", "scanStatus" ], "type" : "object", "properties" : { "networkType" : { "type" : "string", "description" : "This network's type", "example" : "routed", "enum" : [ "routed", "vlan", "wifi", "loopback", "network", "layer2", "internet" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Network Type" }, "networkName" : { "type" : "string", "description" : "Name of this network, usually an IP/subnet or an SSID", "example" : "192.168.4.0/24", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Network Name" }, "description" : { "type" : "string", "description" : "Description of this network, also often an IP/subnet or an SSID", "example" : "192.168.4.0/24", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Description" }, "scanStatus" : { "type" : "string", "description" : "If this network is set to be scanned or not", "example" : "true", "enum" : [ "true", "false", "notAllowed", "unknown" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Scan Status" }, "lastModified" : { "type" : "string", "description" : "When one of this network's attributes was last modified", "example" : "2018-03-12T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Last Modified" } }, "additionalProperties" : false, "description" : "The type-specific properties of the networks object returned" }, "networkRelationships" : { "type" : "object", "properties" : { "networkDetail" : { "$ref" : "#/components/schemas/networkRelationships_networkDetail" }, "tenant" : { "$ref" : "#/components/schemas/tenant" }, "devices" : { "$ref" : "#/components/schemas/networkRelationships_devices" } }, "description" : "This network's relationships to other resources" }, "networkDetailsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "networkDetail" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a network", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/networkDetailsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/networkDetailsRelationships" }, "links" : { "$ref" : "#/components/schemas/networkDetailsResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik network's extra details" }, "networkDetailsAttributes" : { "required" : [ "collectorSelection", "excludedIpAddresses", "primaryCollector", "scope", "secondaryCollectors" ], "type" : "object", "properties" : { "scope" : { "type" : "string", "description" : "Whether this network is a private or public network", "example" : "private", "enum" : [ "private", "public" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Scope" }, "primaryCollector" : { "type" : "string", "description" : "UUID of the primary Auvik collector assigned to this network", "example" : "98a1790e-ec59-481f-8529-4f836b0bd1ca", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Primary Collector" }, "secondaryCollectors" : { "type" : "array", "description" : "List of UUIDs of secondary Auvik collectors assigned to this network, if any", "items" : { "type" : "string", "example" : "8e604713-7606-4e8c-8200-bd6d4317e069" }, "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Secondary Collector" }, "collectorSelection" : { "type" : "string", "description" : "How collectors for this network are selected", "example" : "automatic", "enum" : [ "automatic", "manual" ], "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Collector Selection" }, "excludedIpAddresses" : { "type" : "array", "description" : "IP addresses and IP address ranges on this network that have been excluded from scans", "items" : { "type" : "string", "example" : "192.168.4.10-192.168.4.25" }, "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Excluded IP Address" } }, "additionalProperties" : false, "description" : "The type-specific properties of the networks object returned" }, "networkDetailsRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "This network's relationships to other resources" }, "networkInfoReadSingle" : { "title" : "root networks object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/networksResourceObject" }, "included" : { "uniqueItems" : true, "type" : "array", "items" : { "$ref" : "#/components/schemas/networkDetailsResourceObject" } } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "networkDetailsReadMultiple" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/networkDetailsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/networkDetailsReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "networkDetailsReadSingle" : { "title" : "root devices object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/networkDetailsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "interfaceInfoReadMultiple" : { "title" : "root interfaces object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/interfaceResourceObject" } }, "links" : { "$ref" : "#/components/schemas/interfaceInfoReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "interfaceResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "interface" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a interface", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/interfaceAttributes" }, "links" : { "$ref" : "#/components/schemas/interfaceResourceObject_links" }, "relationships" : { "$ref" : "#/components/schemas/interfaceRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an interface" }, "interfaceAttributes" : { "required" : [ "adminStatus", "customConnections", "duplex", "interfaceName", "interfaceType", "ipAddresses", "lastModified", "macAddress", "negotiatedSpeed", "operationalStatus" ], "type" : "object", "properties" : { "interfaceName" : { "type" : "string", "description" : "This interface's name", "example" : "Interface 1", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Interface Name" }, "interfaceType" : { "type" : "string", "description" : "This interface's type", "example" : "ethernet", "enum" : [ "ethernet", "wifi", "bluetooth", "cdma", "coax", "cpu", "distributedVirtualSwitch", "firewire", "gsm", "ieee8023AdLag", "inferredWired", "inferredWireless", "interface", "linkAggregation", "loopback", "modem", "wimax", "optical", "other", "parallel", "ppp", "radiomac", "rs232", "tunnel", "unknown", "usb", "virtualBridge", "virtualNic", "virtualSwitch", "vlan" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Interface Type" }, "macAddress" : { "type" : "string", "description" : "MAC address", "example" : "1A:2B:3C:4D:5E:6F", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Mac Address" }, "negotiatedSpeed" : { "type" : "string", "description" : "Negotiated speed", "example" : "1.0 Gbit/s", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Negotiated Speed" }, "duplex" : { "type" : "string", "description" : "Duplex mode of this interface", "example" : "full", "enum" : [ "unknown", "half", "full" ], "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Duplex" }, "customConnections" : { "type" : "boolean", "description" : "Whether this interface allows custom connections", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Custom Connections" }, "ipAddresses" : { "type" : "array", "description" : "This interface's IP addresses", "example" : [ "10.0.0.1" ], "items" : { "type" : "string" }, "x-isRequired" : false, "x-isFilter" : false, "x-label" : "IP Address" }, "operationalStatus" : { "type" : "string", "description" : "This interface's operational status", "example" : "online", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Operational Status" }, "adminStatus" : { "type" : "boolean", "description" : "Whether this interface is enabled", "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Admin Status" }, "lastModified" : { "type" : "string", "description" : "When one of this interface's attributes was last modified", "example" : "2018-03-12T12:00:00.000Z", "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Last Modified" } }, "additionalProperties" : false, "description" : "The type-specific properties of the interfaces object returned" }, "interfaceRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "connectedTo" : { "$ref" : "#/components/schemas/interfaceRelationships_connectedTo" }, "networks" : { "$ref" : "#/components/schemas/interfaceRelationships_networks" }, "parentDevice" : { "$ref" : "#/components/schemas/interfaceRelationships_parentDevice" } }, "description" : "This interface's relationships to other resources" }, "interfaceInfoReadSingle" : { "title" : "root interfaces object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/interfaceResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "componentInfoReadMultiple" : { "title" : "root components object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/componentsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/componentInfoReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "componentsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "component" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this component", "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA", "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/componentAttributes" }, "links" : { "$ref" : "#/components/schemas/componentsResourceObject_links" }, "relationships" : { "$ref" : "#/components/schemas/componentRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik component" }, "componentAttributes" : { "required" : [ "componentName", "componentType", "currentStatus", "lastModified" ], "type" : "object", "properties" : { "componentName" : { "type" : "string", "description" : "This component's name", "example" : "CPU Core 26", "x-isFilter" : false, "x-label" : "Component Name" }, "componentType" : { "type" : "string", "description" : "This component's type", "example" : "cpu", "enum" : [ "cpu", "disk", "fan", "memory", "powerSupply", "storageController", "systemBoard" ] }, "currentStatus" : { "type" : "string", "description" : "High level description of this component's status", "example" : "ok", "enum" : [ "ok", "degraded", "failed" ], "x-isFilter" : true, "x-label" : "Current Status" }, "lastModified" : { "type" : "string", "description" : "When one of this component's attributes was last modified", "example" : "2018-03-13T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Last Modified" } }, "additionalProperties" : false, "description" : "The type-specific properties of the components object returned" }, "componentRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "parentDevice" : { "$ref" : "#/components/schemas/componentRelationships_parentDevice" } }, "description" : "This component's relationships to other resources" }, "componentInfoReadSingle" : { "title" : "root components object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/componentsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "entityNotesReadMultiple" : { "title" : "root entity notes object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/noteResourceObject" } }, "links" : { "$ref" : "#/components/schemas/entityNotesReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "noteResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "entityNote" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this note", "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/noteAttributes" }, "relationships" : { "$ref" : "#/components/schemas/noteRelationships" }, "links" : { "$ref" : "#/components/schemas/noteResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik note" }, "noteAttributes" : { "required" : [ "body", "entityId", "entityName", "entityType", "lastModified", "lastModifiedBy", "title" ], "type" : "object", "properties" : { "title" : { "type" : "string", "description" : "This note's title", "example" : "SomeNoteTitle", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Title" }, "body" : { "type" : "string", "description" : "Content of this note", "example" : "This is a note about one of my networks.", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Content" }, "entityId" : { "type" : "string", "description" : "The related entity's ID", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "entityType" : { "type" : "string", "description" : "The related entity type", "example" : "network", "enum" : [ "root", "device", "network", "interface" ], "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Type" }, "entityName" : { "type" : "string", "description" : "The related entity's name", "example" : "192.168.4.0/24", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Name" }, "lastModifiedBy" : { "type" : "string", "description" : "The username that last modified the note", "example" : "John User", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Last Modified By" }, "lastModified" : { "type" : "string", "description" : "When one of this entity note's attributes was last modified", "example" : "2018-03-12T12:00:00.000Z", "x-isRequired" : false, "x-isFilter" : true, "x-label" : "Last Modified" } }, "additionalProperties" : false, "description" : "The type-specific properties of the notes object returned" }, "noteRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "This entity note's relationships to other resources" }, "entityNotesReadSingle" : { "title" : "root entity notes object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/noteResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "entityAuditReadMultiple" : { "title" : "root entity audits object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/auditsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/entityAuditReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "auditsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "entityAudit" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this audit", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw", "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/auditAttributes" }, "relationships" : { "$ref" : "#/components/schemas/auditRelationships" }, "links" : { "$ref" : "#/components/schemas/auditsResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an audit log" }, "auditAttributes" : { "required" : [ "action", "category", "cause", "data", "dateStarted", "direction", "lastActive", "status", "user" ], "type" : "object", "properties" : { "user" : { "type" : "string", "description" : "The user name associated to this audit log", "example" : "John Smith", "x-isFilter" : true, "x-label" : "User" }, "category" : { "type" : "string", "description" : "What service is taking/took this audited action", "example" : "unknown", "enum" : [ "unknown", "tunnel", "terminal", "remoteBrowser" ], "x-isFilter" : true, "x-label" : "Category" }, "action" : { "type" : "string", "description" : "What action is being performed", "example" : "create", "enum" : [ "unknown", "create" ], "x-isFilter" : false, "x-label" : "Action" }, "direction" : { "type" : "string", "description" : "Whether is request is being made into or out of the entity's client", "example" : "inbound", "enum" : [ "unknown", "inbound", "outbound" ], "x-isFilter" : false, "x-label" : "Direction" }, "status" : { "type" : "string", "description" : "State of the audited action", "example" : "created", "enum" : [ "unknown", "initiated", "created", "closed", "failed" ], "x-isFilter" : true, "x-label" : "Status" }, "cause" : { "type" : "string", "description" : "Reason the audited action is in its current state", "example" : "This is an error.", "x-isFilter" : false, "x-label" : "Cause" }, "data" : { "type" : "string", "description" : "Tertiary data related to the audited action", "example" : "This is some message or data related to this action", "x-isFilter" : false, "x-label" : "Data" }, "dateStarted" : { "type" : "string", "description" : "When this audited action was started", "example" : "2018-03-13T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Date Started" }, "lastActive" : { "type" : "string", "description" : "When this audited action was last active", "example" : "2018-03-12T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Last Active" } }, "additionalProperties" : false, "description" : "The type-specific properties of the audit object returned" }, "auditRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "device" : { "$ref" : "#/components/schemas/auditRelationships_device" } }, "description" : "This entity audit's relationships to other resources" }, "entityAuditReadSingle" : { "title" : "root entity audits object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/auditsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "userTenantsReadMultiple" : { "title" : "root tenants object", "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", "items" : { "$ref" : "#/components/schemas/tenantsResourceObject" } } }, "additionalProperties" : false, "description" : "root level object per the json-api spec" }, "tenantsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "tenant" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "0987654321", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/tenantAttributes" }, "relationships" : { "$ref" : "#/components/schemas/tenantsResourceObject_relationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik tenant" }, "tenantAttributes" : { "required" : [ "domainPrefix", "name", "tenantType" ], "type" : "object", "properties" : { "domainPrefix" : { "type" : "string", "description" : "The domain prefix of the tenant", "example" : "sampledomain" }, "tenantType" : { "type" : "string", "description" : "The type of tenant in Auvik. A finite list of enumerated string values", "enum" : [ "corporateIt", "client", "multiClient" ] } }, "additionalProperties" : false, "description" : "The type specific properties of the tenants object returned" }, "tenantsDetailReadMultiple" : { "title" : "root legacy tenants object", "type" : "object", "properties" : { "data" : { "type" : "array", "description" : "An array of resource objects, an array of resource identifier objects, or an empty array ([]), for requests that target resource collections.", "items" : { "$ref" : "#/components/schemas/tenantDetailResourceObject" }, "x-omitempty" : false } }, "additionalProperties" : false, "description" : "root level object per the json-api spec" }, "tenantDetailResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "tenants" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "0987654321", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/tenantDetailAttributes" }, "relationships" : { "$ref" : "#/components/schemas/tenantDetailResourceObject_relationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik legacy tenant" }, "tenantDetailAttributes" : { "required" : [ "domainPrefix", "enabled", "name", "running", "subscribed", "subscriptionOwner", "tenantType" ], "type" : "object", "properties" : { "domainPrefix" : { "type" : "string", "description" : "The domain prefix of the tenant", "example" : "sampledomain" }, "displayName" : { "type" : "string", "description" : "Display name used within Auvik", "example" : "Example Company Inc.", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Name" }, "tenantType" : { "type" : "string", "description" : "The type of tenant in Auvik. A finite list of enumerated string values", "enum" : [ "corporateIt", "client", "multiClient" ] }, "enabled" : { "type" : "boolean", "description" : "Whether or not the tenant is enabled" }, "subscribed" : { "type" : "boolean", "description" : "Whether or not the tenant is subscribed" }, "subscriptionOwner" : { "type" : "string", "description" : "The owner who subscribes the tenant", "example" : "None" }, "running" : { "type" : "boolean", "description" : "Whether or not the tenant is running" }, "trialStartDate" : { "type" : "string", "description" : "Start date of trial", "example" : "2017-01-01T12:00:00.000-0500" }, "trialEndDate" : { "type" : "string", "description" : "Start date of trial", "example" : "2017-01-01T12:00:00.000-0500" }, "address" : { "$ref" : "#/components/schemas/tenantDetailAttributes_address" } }, "additionalProperties" : false, "description" : "The type specific properties of the tenants object returned" }, "tenantsDetailReadSingle" : { "title" : "root tenants object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/tenantDetailResourceObject" } }, "additionalProperties" : false, "description" : "root level object per the json-api spec" }, "alertHistoryInfoReadMultiple" : { "title" : "root alerts object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/alertsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/alertHistoryInfoReadMultiple_links" }, "meta" : { "$ref" : "#/components/schemas/meta" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "alertsResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the api", "enum" : [ "alert" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this alert", "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA" }, "attributes" : { "$ref" : "#/components/schemas/alertAttributes" }, "links" : { "$ref" : "#/components/schemas/alertsResourceObject_links" }, "relationships" : { "$ref" : "#/components/schemas/alertRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Alert message" }, "alertAttributes" : { "required" : [ "description", "detectedOn", "dismissed", "dispatched", "externalTicket", "name", "severity", "status" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "This alert's name", "example" : "Printer - Low Ink Level" }, "severity" : { "type" : "string", "description" : "This severity of the alert message", "example" : "warning", "enum" : [ "unknown", "emergency", "critical", "warning", "info" ] }, "status" : { "type" : "string", "description" : "High level description of this alert's status", "example" : "created", "enum" : [ "created", "resolved", "paused", "unpaused" ] }, "alertDefinitionId" : { "type" : "string", "description" : "Alert Definition ID linked to Alert type", "example" : "MTUyOTA0ODIyMzg5ODgwOTMwLDAsMTIzNAo" }, "specificationId" : { "type" : "string", "description" : "Specification ID linked to Alert type. Use alertDefinitionId instead", "example" : "-400", "deprecated" : true }, "detectedOn" : { "type" : "string", "description" : "The date time of the alert's message was detected", "example" : "2018-11-22T22:07:18.407Z" }, "description" : { "type" : "string", "description" : "This description of the alert", "example" : "This printer is reporting an ink percentage of 20% for black ink" }, "dismissed" : { "type" : "boolean", "description" : "Whether the alert has been dismissed or not" }, "dispatched" : { "type" : "boolean", "description" : "Whether the alert has been dispatched or not" }, "externalTicket" : { "type" : "array", "description" : "The external ticket list associated to current alert message", "items" : { "$ref" : "#/components/schemas/alertAttributes_externalTicket" } } }, "additionalProperties" : false, "description" : "The type-specific properties of the alerts object returned" }, "alertRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "relatedAlert" : { "$ref" : "#/components/schemas/alertRelationships_relatedAlert" }, "entity" : { "$ref" : "#/components/schemas/alertRelationships_entity" } }, "description" : "This interface's relationships to other resources" }, "alertHistoryInfoReadSingle" : { "title" : "root alerts object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/alertsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "clientUsageRead" : { "title" : "root client usage object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/clientUsageResourceObject" } } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "clientUsageResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Client tenant's ID", "example" : "199762235015168516" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "clientUsage" ] }, "attributes" : { "$ref" : "#/components/schemas/clientUsageAttributes" }, "relationships" : { "$ref" : "#/components/schemas/clientUsageRelationships" }, "links" : { "$ref" : "#/components/schemas/clientUsageResourceObject_links" } }, "additionalProperties" : false, "description" : "Client usage resource object" }, "clientUsageAttributes" : { "type" : "object", "properties" : { "monitoredWorkstations" : { "type" : "array", "description" : "List of daily numbers of monitored workstation", "items" : { "$ref" : "#/components/schemas/clientUsageAttributes_monitoredWorkstations" } }, "monitoredServers" : { "type" : "array", "description" : "List of daily numbers of monitored servers", "items" : { "$ref" : "#/components/schemas/clientUsageAttributes_monitoredServers" } }, "maxMonitoredWorkstations" : { "type" : "number", "description" : "High watermark of monitored Work Stations for the billing period selected", "example" : 3 }, "maxMonitoredServers" : { "type" : "number", "description" : "High watermark of monitored Servers for the billing period selected", "example" : 4 }, "domainPrefix" : { "type" : "string", "description" : "Client tenant's domain prefix/name", "example" : "sampledomain" }, "billableDays" : { "type" : "number", "description" : "Days this client (and its children) was billable for across the usage period.", "example" : 30 }, "usagePeriod" : { "$ref" : "#/components/schemas/clientUsageAttributes_usagePeriod" }, "deviceUsage" : { "$ref" : "#/components/schemas/clientUsageAttributes_deviceUsage" }, "clientUsage" : { "$ref" : "#/components/schemas/clientUsageAttributes_clientUsage" }, "asmUserUsage" : { "$ref" : "#/components/schemas/clientUsageAttributes_asmUserUsage" } }, "description" : "The type-specific properties of the client usage object returned" }, "clientUsageRelationships" : { "type" : "object", "properties" : { "devices" : { "$ref" : "#/components/schemas/clientUsageRelationships_devices" }, "clients" : { "$ref" : "#/components/schemas/clientUsageRelationships_clients" }, "asmUsers" : { "$ref" : "#/components/schemas/clientUsageRelationships_asmUsers" } }, "description" : "Client usage object's relationships to other resources" }, "deviceUsageRead" : { "title" : "root device usage object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceUsageResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceUsageResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "Device's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "deviceUsage" ] }, "attributes" : { "$ref" : "#/components/schemas/deviceUsageAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceUsageRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceUsageResourceObject_links" } }, "additionalProperties" : false, "description" : "Device usage resource object" }, "deviceUsageAttributes" : { "type" : "object", "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint" }, "usagePeriod" : { "$ref" : "#/components/schemas/clientUsageAttributes_usagePeriod" }, "totalDays" : { "type" : "number", "description" : "The total billable device days across the usage period", "example" : 30 }, "averageDays" : { "type" : "number", "description" : "The average billable device days across the usage period", "example" : 1 }, "totalDaysByClientType" : { "$ref" : "#/components/schemas/deviceUsageAttributes_totalDaysByClientType" }, "averageDaysByClientType" : { "$ref" : "#/components/schemas/deviceUsageAttributes_averageDaysByClientType" } }, "description" : "The type-specific properties of the client usage object returned" }, "deviceUsageRelationships" : { "type" : "object", "properties" : { "client" : { "$ref" : "#/components/schemas/deviceUsageRelationships_client" } }, "description" : "Client usage object's relationships to other resources" }, "deviceStatisticsRead" : { "title" : "root device statistics object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceStatisticsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceStatisticsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID for this statistic", "example" : "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "deviceStatistics" ] }, "attributes" : { "$ref" : "#/components/schemas/statisticsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceStatisticsRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceStatisticsResourceObject_links" } }, "additionalProperties" : false, "description" : "Device statistics resource object" }, "statisticsAttributes" : { "type" : "object", "properties" : { "reportPeriod" : { "$ref" : "#/components/schemas/reportPeriod" }, "interval" : { "$ref" : "#/components/schemas/interval" }, "statType" : { "$ref" : "#/components/schemas/statType" }, "stats" : { "type" : "array", "description" : "The list of statistics reported for the entity", "items" : { "$ref" : "#/components/schemas/statItem" } } }, "additionalProperties" : false, "description" : "The type-specific properties of the statistics object returned" }, "reportPeriod" : { "type" : "object", "properties" : { "fromTime" : { "type" : "string", "description" : "Start timestamp for the statistics query", "example" : "2020-02-18T00:00:00.000Z", "x-isFilter" : true }, "thruTime" : { "type" : "string", "description" : "End timestamp for the statistics query", "example" : "2020-02-19T00:00:00.000Z", "x-isFilter" : true } }, "description" : "Reporting period for the returned statistics" }, "interval" : { "type" : "string", "description" : "The reporting interval for the statistics", "example" : "hour", "x-isFilter" : true }, "statType" : { "type" : "string", "description" : "The type of statistic that was returned", "example" : "statTypeName", "x-isFilter" : true }, "statItem" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Name of the statistic", "example" : "Statistic name" }, "index" : { "type" : "string", "description" : "Index for multi-part statistics", "example" : "1" }, "legend" : { "type" : "array", "description" : "A description of the stats data columns", "items" : { "type" : "string", "description" : "Data column description", "example" : "Statistic value" } }, "unit" : { "type" : "array", "description" : "Unit type for each stats data column", "items" : { "type" : "string", "description" : "Unit type name", "example" : "percent" } }, "data" : { "type" : "array", "description" : "An list of rows of statistics data, as described by the legend", "items" : { "type" : "array", "description" : "An array of statistics data columns", "items" : { "type" : "double", "description" : "An individual data point" } } } }, "additionalProperties" : false }, "deviceStatisticsRelationships" : { "type" : "object", "properties" : { "device" : { "$ref" : "#/components/schemas/deviceStatisticsRelationships_device" }, "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "Device statistics object's relationships to other resources" }, "deviceAvailabilityStatisticsRead" : { "title" : "root device availability statistics object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/deviceAvailabilityStatisticsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceAvailabilityStatisticsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID for this statistic", "example" : "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "deviceAvailabilityStatistics" ] }, "attributes" : { "$ref" : "#/components/schemas/statisticsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/deviceStatisticsRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceStatisticsResourceObject_links" } }, "additionalProperties" : false, "description" : "Device availability statistics resource object" }, "serviceStatisticsRead" : { "title" : "root service statistics object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/serviceStatisticsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "serviceStatisticsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID for this statistic", "example" : "NzkyMywxOTgzNTA5OTc0NDM3MTU4NDQsc3RhdC9kZXZpY2UvYmFuZHdpZHRoOmhvdXI" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "serviceStatistics" ] }, "attributes" : { "$ref" : "#/components/schemas/serviceStatisticsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/serviceStatisticsRelationships" }, "links" : { "$ref" : "#/components/schemas/serviceStatisticsResourceObject_links" } }, "additionalProperties" : false, "description" : "Service statistics resource object" }, "serviceStatisticsAttributes" : { "required" : [ "interval", "reportPeriod" ], "type" : "object", "properties" : { "reportPeriod" : { "$ref" : "#/components/schemas/reportPeriod" }, "interval" : { "$ref" : "#/components/schemas/interval" }, "statType" : { "$ref" : "#/components/schemas/statType" }, "endpoints" : { "type" : "array", "description" : "Endpoints checked by a cloud ping check service", "items" : { "$ref" : "#/components/schemas/endpointStats" } } }, "additionalProperties" : false, "description" : "The type-specific properties of the statistics object returned" }, "endpointStats" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID of the endpoint", "example" : "NzkyMyw1NTcxNjU0Njc2MTQwODY4MTI" }, "ipAddress" : { "type" : "string", "description" : "IP Address of the endpoint", "example" : "192.0.2.10" }, "stats" : { "type" : "array", "description" : "The list of statistics reported for the endpoint", "items" : { "$ref" : "#/components/schemas/statItem" } } } }, "serviceStatisticsRelationships" : { "type" : "object", "properties" : { "service" : { "$ref" : "#/components/schemas/serviceStatisticsRelationships_service" }, "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "additionalProperties" : false, "description" : "Service statistics object's relationships to other resources" }, "interfaceStatisticsRead" : { "title" : "root interface statistics object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/interfaceStatisticsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "interfaceStatisticsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID for this statistic", "example" : "NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "interfaceStatistics" ] }, "attributes" : { "$ref" : "#/components/schemas/statisticsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/interfaceStatisticsRelationships" }, "links" : { "$ref" : "#/components/schemas/interfaceStatisticsResourceObject_links" } }, "additionalProperties" : false, "description" : "Interface statistics resource object" }, "interfaceStatisticsRelationships" : { "type" : "object", "properties" : { "interface" : { "$ref" : "#/components/schemas/interfaceStatisticsRelationships_interface" }, "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "Interface statistics object's relationships to other resources" }, "componentStatisticsRead" : { "title" : "root component statistics object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/componentStatisticsResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "componentStatisticsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "ID for this statistic", "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "componentStatistics" ] }, "attributes" : { "$ref" : "#/components/schemas/statisticsAttributes" }, "relationships" : { "$ref" : "#/components/schemas/componentStatisticsRelationships" }, "links" : { "$ref" : "#/components/schemas/componentStatisticsResourceObject_links" } }, "additionalProperties" : false, "description" : "Component statistics resource object" }, "componentStatisticsRelationships" : { "type" : "object", "properties" : { "component" : { "$ref" : "#/components/schemas/componentStatisticsRelationships_component" }, "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "Component statistics object's relationships to other resources" }, "deviceOidMonitorRead" : { "title" : "root oid statistics object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/deviceOidMonitorResourceObject" } }, "links" : { "$ref" : "#/components/schemas/deviceOidMonitorRead_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "deviceOidMonitorResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceOidMonitor" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an OID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/oidAttributes" }, "relationships" : { "$ref" : "#/components/schemas/oidRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceOidMonitorResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik device OID" }, "oidAttributes" : { "required" : [ "oid" ], "type" : "object", "properties" : { "oid" : { "type" : "string", "description" : "OID identifier", "example" : "1.3.6.1.4.1.17373.4.1.2.1.5.1", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID identifier" }, "oidName" : { "type" : "string", "description" : "OID name", "example" : "Environmental probe", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID Name" }, "value" : { "type" : "double", "description" : "OID value", "example" : 123, "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID Value" } }, "additionalProperties" : false, "description" : "The type-specific properties of the OID object returned" }, "oidRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "device" : { "$ref" : "#/components/schemas/oidRelationships_device" } }, "description" : "This OID's relationships to other resources" }, "snmpPollerSettingsRead" : { "title" : "root snmp poller settings object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/snmpPollerSettingsResourceObject" } }, "links" : { "$ref" : "#/components/schemas/snmpPollerSettingsRead_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "snmpPollerSettingsResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for an OID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "type" : { "type" : "string", "description" : "The type of object in the API", "example" : "snmpPollerSetting" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerSettingAttributes" }, "relationships" : { "$ref" : "#/components/schemas/snmpPollerSettingRelationships" }, "links" : { "$ref" : "#/components/schemas/deviceOidMonitorResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik SNMP Poller Setting" }, "snmpPollerSettingAttributes" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "SNMP Poller Setting name", "example" : "Cisco CPU Usage", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "SNMP Poller Setting Name" }, "protocol" : { "type" : "string", "description" : "Protocol", "example" : "snmp", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Protocol" }, "oid" : { "type" : "string", "description" : "OID identifier", "example" : "1.3.6.1.4.1.17373.4.1.2.1.5.1", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID identifier" }, "type" : { "type" : "string", "description" : "SNMP Poller Setting type", "example" : "string", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID Type" }, "useAs" : { "type" : "string", "description" : "Underlying use of this poller (serialNo, poller)", "example" : "poller", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Use as" } }, "additionalProperties" : false, "description" : "The type-specific properties of the SNMP Poller Settings object returned" }, "snmpPollerSettingRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "This SNMP Poller Setting's relationships to other resources" }, "snmpPollerSettingSingleRead" : { "title" : "root snmp poller settings object", "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/snmpPollerSettingSingleResourceObject" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "snmpPollerSettingSingleResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for a SNMP Poller Setting", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "type" : { "type" : "string", "description" : "The type of object in the API", "example" : "snmpPollerSetting" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerSettingAttributes" }, "relationships" : { "$ref" : "#/components/schemas/snmpPollerSettingRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik SNMP Poller Setting" }, "snmpPollerSettingAttributes_2" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "SNMP Poller Setting's name", "example" : "Cisco CPU Usage", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "SNMP Poller Setting's Name" }, "protocol" : { "type" : "string", "description" : "Protocol", "example" : "snmp", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Protocol" }, "oid" : { "type" : "string", "description" : "OID identifier", "example" : "1.3.6.1.4.1.17373.4.1.2.1.5.1", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID identifier" }, "type" : { "type" : "string", "description" : "SNMP Poller Setting's type", "example" : "string", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "SNMP Poller Setting's Type" }, "useAs" : { "type" : "string", "description" : "Underlying use of this snmp poller(serialNo, Monitor)", "example" : "0", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Use as" } }, "additionalProperties" : false, "description" : "The type-specific properties of the SNMP Poller Setting object returned" }, "snmpPollerSettingRelationships_2" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" } }, "description" : "This SNMP Poller Setting's relationships to other resources" }, "snmpPollerSettingDevicesRead" : { "title" : "root snmp poller setting's devices object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/snmpPollerSettingDeviceResourceObject" } }, "links" : { "$ref" : "#/components/schemas/snmpPollerSettingDevicesRead_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "snmpPollerSettingDeviceResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "type" : { "type" : "string", "description" : "The type of object in the API", "example" : "snmpPollerSettingDevice" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerSettingDeviceAttributes" }, "relationships" : { "$ref" : "#/components/schemas/snmpPollerSettingDeviceRelationships" }, "links" : { "$ref" : "#/components/schemas/snmpPollerSettingDeviceResourceObject_links" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an Auvik Device for a specific SNMP Poller setting" }, "snmpPollerSettingDeviceAttributes" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "Device name", "example" : "Cisco Router", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Device Name" }, "type" : { "type" : "string", "description" : "Device type", "example" : "accessPoint", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Device Type" } }, "additionalProperties" : false, "description" : "The type-specific properties of the Device object returned" }, "snmpPollerSettingDeviceRelationships" : { "type" : "object", "properties" : { "tenant" : { "$ref" : "#/components/schemas/tenant" }, "snmpPollerSetting" : { "$ref" : "#/components/schemas/snmpPollerSetting" } }, "description" : "This device's relationships to other resources" }, "snmpPollerSetting" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/snmpPollerSetting_data" } }, "description" : "The template for a resource object representing an Auvik SNMP Poller Setting" }, "snmpPollerStringHistoryRead" : { "title" : "root snmp poller history for string values object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryResourceObject" } }, "links" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryRead_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "snmpPollerStringHistoryResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for a set of history SNMP Poller Setting's values", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "type" : { "type" : "string", "description" : "The type of object in the API", "example" : "snmpPollerHistoryStatistics" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryAttributes" }, "relationships" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing the history of a String SNMP Poller Setting's values" }, "snmpPollerStringHistoryAttributes" : { "type" : "object", "properties" : { "reportPeriod" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryAttributes_reportPeriod" }, "stats" : { "type" : "array", "description" : "The list of historical values reported for the String SNMP Poller Setting", "items" : { "$ref" : "#/components/schemas/statItem_2" } } }, "additionalProperties" : false, "description" : "The type-specific properties of the SNMP Poller Setting's history object returned" }, "statItem_2" : { "type" : "object", "properties" : { "legend" : { "type" : "array", "description" : "A description of the stats data columns", "items" : { "type" : "string", "description" : "Data column description", "example" : "String Value" } }, "data" : { "type" : "array", "description" : "A list of rows of historical values, as described by the legend", "items" : { "type" : "array", "description" : "An array of historical data columns", "items" : { "description" : "An individual data point", "oneOf" : [ { "type" : "string" }, { "type" : "double" } ] } } } }, "additionalProperties" : false }, "snmpPollerStringHistoryRelationships" : { "type" : "object", "properties" : { "snmpPollerSetting" : { "$ref" : "#/components/schemas/snmpPollerSettingReduced" }, "device" : { "$ref" : "#/components/schemas/device" }, "tenant" : { "$ref" : "#/components/schemas/tenantReduced" } }, "description" : "This history of SNMP Poller Setting's values relationships to other resources" }, "snmpPollerSettingReduced" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/snmpPollerSettingReduced_data" } }, "description" : "The template for a resource object representing an Auvik SNMP Poller Setting" }, "device" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/device_data" } }, "description" : "The template for a resource object representing a device" }, "tenantReduced" : { "type" : "object", "properties" : { "data" : { "$ref" : "#/components/schemas/tenantReduced_data" } }, "description" : "This entity's owning tenant" }, "snmpPollerIntHistoryRead" : { "title" : "root snmp poller history for Int values object", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/snmpPollerIntHistoryResourceObject" } }, "links" : { "$ref" : "#/components/schemas/snmpPollerIntHistoryRead_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "snmpPollerIntHistoryResourceObject" : { "type" : "object", "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for a set of history SNMP Poller Setting's values", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "type" : { "type" : "string", "description" : "The type of object in the API", "example" : "snmpPollerHistoryStatistics" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerIntHistoryAttributes" }, "relationships" : { "$ref" : "#/components/schemas/snmpPollerIntHistoryRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing the history of a Integer SNMP Poller Setting's values" }, "snmpPollerIntHistoryAttributes" : { "type" : "object", "properties" : { "reportPeriod" : { "$ref" : "#/components/schemas/snmpPollerStringHistoryAttributes_reportPeriod" }, "interval" : { "type" : "string", "description" : "Statistics reporting interval", "example" : "hour", "enum" : [ "minute", "hour", "Day" ] }, "stats" : { "type" : "array", "description" : "The list of historical values reported for the String SNMP Poller Setting", "items" : { "$ref" : "#/components/schemas/statItem_2" } } }, "additionalProperties" : false, "description" : "The type-specific properties of the SNMP Poller Setting's history object returned" }, "snmpPollerIntHistoryRelationships" : { "type" : "object", "properties" : { "snmpPollerSetting" : { "$ref" : "#/components/schemas/snmpPollerSettingReduced" }, "device" : { "$ref" : "#/components/schemas/device" }, "tenant" : { "$ref" : "#/components/schemas/tenantReduced" } }, "description" : "This history of SNMP Poller Setting's values relationships to other resources" }, "appReadMultiple" : { "title" : "ASM app response", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/asmAppResourceObject" } }, "links" : { "$ref" : "#/components/schemas/appReadMultiple_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "asmAppResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmApp" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM app", "example" : "f0dc6172-ce98-4eec-a375-5be40db3e920", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/asmAppAttributes" }, "relationships" : { "$ref" : "#/components/schemas/asmAppRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an ASM app." }, "asmAppAttributes" : { "required" : [ "applicationId", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the app", "example" : "OpenAI", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Name" }, "category" : { "type" : "string", "description" : "The category of the app", "example" : "IT and Security / AI", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Category" }, "subCategory" : { "type" : "string", "description" : "The subCategory of the app", "example" : "Data Visualization", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Sub-category" }, "risk" : { "type" : "string", "description" : "The risk level of the app", "example" : "90", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Risk" }, "dateAdded" : { "type" : "string", "description" : "The date the app was added", "example" : "2024-09-18T05:33:44.000Z", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Date Added" }, "classified" : { "type" : "boolean", "description" : "The classification status the app", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Is Classified" }, "disabled" : { "type" : "boolean", "description" : "The disabled status of the app", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Is Disabled" }, "status" : { "type" : "string", "description" : "Status of the app", "example" : "not_configured", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Application Status" }, "managedByPartner" : { "type" : "boolean", "description" : "Whether the app is managed by a partner", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Managed By Partner" }, "managed3rdParty" : { "type" : "boolean", "description" : "Wether the app is managed by a 3rd party", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Managed by 3rd party" }, "noBusinessOwnerRequired" : { "type" : "boolean", "description" : "If a business owner is required", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "No Business Owner Required" }, "businessOwnerPlatformUserId" : { "type" : "string", "description" : "The Platform User ID of the business owner", "example" : "cfd2fbgb-10be-4c2d-918c-03dad83e5803", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Business Owner Platform User ID" }, "publisherId" : { "type" : "string", "description" : "The ID of the publisher", "example" : "cfd2fbgb-10be-4c2d-918c-03dad83e5803", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Publisher ID" }, "publisherName" : { "type" : "string", "description" : "The name of the publisher", "example" : "Microsoft Corporation", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Publisher Name" }, "publisherDescription" : { "type" : "string", "description" : "The description of the publisher", "example" : "Microsoft is a multinational technology company that develops, manufactures, licenses, and supports software products", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Publisher Description" }, "identifiers" : { "type" : "array", "description" : "Strings used to identify the application", "items" : { "type" : "string" }, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Identifiers" }, "sources" : { "$ref" : "#/components/schemas/asmActivitySources" }, "totalUsers" : { "$ref" : "#/components/schemas/asmApplicationTotalUsers" }, "accessData" : { "$ref" : "#/components/schemas/asmApplicationAccessData" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM app object returned" }, "asmActivitySources" : { "type" : "object", "properties" : { "cloudActivityCount" : { "type" : "number", "description" : "The number of times a user has accessed this application online", "example" : 8, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Cloud Activity Count" }, "cloudLoginCount" : { "type" : "number", "description" : "The number of times a user has logged into this application online", "example" : 1, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Cloud Login Count" }, "desktopActivityCount" : { "type" : "number", "description" : "The number of times a user has accessed this application on the desktop", "example" : 1, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Desktop Activity Count" }, "downloadActivityCount" : { "type" : "number", "description" : "The number of times a user has downloaded a file while using this application online", "example" : 1, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Download Activity Count" }, "quickScanCount" : { "type" : "number", "description" : "The number of times a user has accessed this application online, specifically found in browser history", "example" : 0, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Quickscan Count" }, "azureSignInCount" : { "type" : "number", "description" : "The number of times a user has signed into this application using Azure", "example" : 3, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Azure SSO Sign-In Count" }, "googleSignInCount" : { "type" : "number", "description" : "The number of times a user has signed into this application using Google Workspace", "example" : 0, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Google Workspace Sign-In Count" }, "googleSSO" : { "type" : "number", "description" : "The number of times a user has signed into this application using Google SSO", "example" : 2, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Google SSO Sign-In Count" }, "microsoftSSO" : { "type" : "number", "description" : "The number of times a user has signed into this application using Microsoft SSO", "example" : 2, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Microsoft SSO Sign-In Count" } }, "description" : "Sources of activity related to this application", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Activity Sources" }, "asmApplicationTotalUsers" : { "type" : "object", "properties" : { "count" : { "type" : "number", "description" : "The number of users with activity related to this application", "example" : 9, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Total User Count" }, "monthlyCount" : { "type" : "number", "description" : "The number of users in the last month with activity related to this application", "example" : 7, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Total Monthly User Count" } }, "description" : "Totals for users with activity related to this application", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "User Totals" }, "asmApplicationAccessData" : { "type" : "object", "properties" : { "accountsDetected" : { "type" : "boolean", "description" : "Have any accounts been detected logging in to this application?", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Accounts Detected" }, "workAccountLoginsDetected" : { "type" : "boolean", "description" : "Have any work accounts been detected logging in to this application?", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Work Accounts Detected" }, "personalAccountLoginsDetected" : { "type" : "boolean", "description" : "Have any personal accounts been detected logging in to this application?", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Personal Accounts Detected" }, "userCountWithWorkAccountLogin" : { "type" : "number", "description" : "Count of users that have logged in to this application with a work account", "example" : 0, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Users with Work Account Logins Detected" }, "userCountWithPersonalAccountLogin" : { "type" : "number", "description" : "Count of users that have logged in to this application with a personal account", "example" : 0, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Users with Personal Account Logins Detected" }, "workLoginPercent" : { "type" : "number", "description" : "Percentage of logins detected that are from work accounts as opposed to personal accounts", "example" : 100, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Percentage of Work Account Logins" } }, "description" : "Specific details about users accessing this application", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Access Data" }, "asmAppRelationships" : { "type" : "object", "properties" : { "breaches" : { "$ref" : "#/components/schemas/asmAppRelationships_breaches" }, "contracts" : { "$ref" : "#/components/schemas/asmAppRelationships_contracts" }, "users" : { "$ref" : "#/components/schemas/asmAppRelationships_users" }, "client" : { "$ref" : "#/components/schemas/asmAppRelationships_client" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM app object returned" }, "clientReadMultiple" : { "title" : "ASM Client response", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/asmClientResourceObject" } }, "links" : { "$ref" : "#/components/schemas/clientReadMultiple_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "asmClientResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmClient" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM Client", "example" : "86e9d241-16d0-4c9e-abc9-0ecd682cf906", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/asmClientAttributes" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an ASM client." }, "asmClientAttributes" : { "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the Client", "example" : "clientName", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM Client Name" }, "dateAdded" : { "type" : "string", "description" : "Date Added", "example" : "2022-11-24 04:22:08.585696+00", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Date the client was added" }, "externalClientID" : { "type" : "string", "description" : "External Client ID", "example" : "1mowmf", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "External client ID" }, "totals" : { "$ref" : "#/components/schemas/asmClientAttributes_totals" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM Client object returned" }, "securityLogReadMultiple" : { "title" : "ASM securityLog response", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/asmSecurityLogResourceObject" } }, "links" : { "$ref" : "#/components/schemas/securityLogReadMultiple_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "asmSecurityLogResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmSecurityLog" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM SecurityLog", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/asmSecurityLogAttributes" }, "relationships" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an ASM Security Log." }, "asmSecurityLogAttributes" : { "type" : "object", "properties" : { "credential" : { "type" : "string", "description" : "The credential associated with this security log", "example" : "general@example.com", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Credential" }, "dateAdded" : { "type" : "string", "description" : "The date this security log was added", "example" : "2024-07-09T17:01:39.250Z", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Date Added" }, "shared" : { "type" : "boolean", "description" : "Whether this security log is shared", "example" : true, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Shared" }, "generic" : { "type" : "boolean", "description" : "Whether this security log is a generic", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Generic" }, "personal" : { "type" : "boolean", "description" : "Whether this security log is categorized as personal", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Personal" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM SecurityLog object returned" }, "asmSecurityLogRelationships" : { "type" : "object", "properties" : { "application" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_application" }, "user" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_user" }, "client" : { "$ref" : "#/components/schemas/asmAppRelationships_client" } }, "additionalProperties" : false, "description" : "Objects related to the ASM security log object returned" }, "tagReadMultiple" : { "title" : "ASM tag response", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/asmTagResourceObject" } }, "links" : { "$ref" : "#/components/schemas/securityLogReadMultiple_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "asmTagResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmTag" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM tag", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/asmTagAttributes" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an ASM tag." }, "asmTagAttributes" : { "required" : [ "applicationId", "name" ], "type" : "object", "properties" : { "name" : { "type" : "string", "description" : "The name of the tag", "example" : "PCI Compliant", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM Tag Name" }, "applicationId" : { "type" : "string", "description" : "The unique identifier of the application that has this tag.", "example" : "86e9d241-16d0-4c9e-abc9-0ecd682cf906", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM Tag Application ID" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM Tag object returned" }, "userReadMultiple" : { "title" : "ASM User response", "type" : "object", "properties" : { "data" : { "type" : "array", "items" : { "$ref" : "#/components/schemas/asmUserResourceObject" } }, "links" : { "$ref" : "#/components/schemas/userReadMultiple_links" } }, "additionalProperties" : false, "description" : "Root level object per the json-api spec" }, "asmUserResourceObject" : { "type" : "object", "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmUser" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM User", "example" : "060b22f5-9626-4da3-8a05-883153a1b4be", "x-isRequired" : true, "x-isFilter" : true, "x-label" : "ID" }, "attributes" : { "$ref" : "#/components/schemas/asmUserAttributes" }, "relationships" : { "$ref" : "#/components/schemas/asmUserRelationships" } }, "additionalProperties" : false, "description" : "The template for a resource object representing an ASM User." }, "asmUserAttributes" : { "required" : [ "active", "dateAdded", "disabled", "email", "expired", "firstName", "id", "lastName" ], "type" : "object", "properties" : { "firstName" : { "type" : "string", "description" : "The first name of the user", "example" : "John", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM User First Name" }, "lastName" : { "type" : "string", "description" : "The last name of the user", "example" : "Doe", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM User Last Name" }, "email" : { "type" : "string", "description" : "email of the User", "example" : "johndoe@google.com", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "ASM email" }, "dateAdded" : { "type" : "string", "description" : "The date this user was added", "example" : "2024-09-04T05:32:36.480Z", "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Date Added" }, "disabled" : { "type" : "boolean", "description" : "Whether or not the user is disabled", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Disabled" }, "expired" : { "type" : "boolean", "description" : "Whether or not the user is expired", "example" : false, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Disabled" }, "active" : { "type" : "boolean", "description" : "Whether or not the user is active", "example" : true, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Active Status" }, "credentials" : { "type" : "array", "description" : "The user's credentials", "items" : { "type" : "string" }, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Credentials" } }, "additionalProperties" : false, "description" : "The type-specific properties of the ASM User object returned" }, "asmUserRelationships" : { "type" : "object", "properties" : { "applications" : { "$ref" : "#/components/schemas/asmUserRelationships_applications" } }, "additionalProperties" : false, "description" : "Objects related to the ASM User object returned" }, "baseDeviceExtendedDetailsAttributes" : { "required" : [ "deviceName" ], "type" : "object", "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "SomeDevice" }, "lastModified" : { "type" : "string", "description" : "When one of this device's attributes was last modified", "example" : "2018-03-12T12:00:00.000Z", "x-isFilter" : true, "x-label" : "Last Modified" }, "lastSeenTime" : { "type" : "string", "description" : "Last seen online date/time of a device", "example" : "2018-11-30T18:34:39.452Z", "x-isFilter" : true, "x-label" : "Last Seen Time" } }, "description" : "The type-specific properties of the devices object returned" }, "deviceInfoReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info?page[last]=300" } }, "description" : "Pagination related links" }, "devicesResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this device", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" }, "deviceRelationships_networks_attributes" : { "required" : [ "networkName" ], "properties" : { "networkName" : { "type" : "string", "description" : "Identifier of the network, usually an IP/subnet or an SSID", "example" : "192.168.4.0/24" } }, "description" : "The type-specific properties of the interfaces object returned" }, "deviceRelationships_networks_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this network", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "dashboard" : { "type" : "string", "description" : "Link to this network's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard" } }, "description" : "Links relating to this network" }, "deviceRelationships_networks_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "network" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this network", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceRelationships_networks_attributes" }, "links" : { "$ref" : "#/components/schemas/deviceRelationships_networks_links" } } }, "deviceRelationships_networks" : { "properties" : { "data" : { "type" : "array", "description" : "An network resource object", "items" : { "$ref" : "#/components/schemas/deviceRelationships_networks_data" } } }, "description" : "This device's networks" }, "deviceRelationships_deviceDetail_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard" }, "self" : { "type" : "string", "description" : "Link to this device detail", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" } }, "description" : "Links relating to this device details" }, "deviceRelationships_deviceDetail_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "deviceDetail" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this device", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "links" : { "$ref" : "#/components/schemas/deviceRelationships_deviceDetail_data_links" } }, "description" : "A device detail object" }, "deviceRelationships_deviceDetail" : { "properties" : { "data" : { "$ref" : "#/components/schemas/deviceRelationships_deviceDetail_data" } }, "description" : "Additional attributes and details relating to this device" }, "tenant_data_attributes" : { "required" : [ "domainPrefix" ], "properties" : { "domainPrefix" : { "type" : "string", "description" : "The domain prefix of the tenant", "example" : "sampledomain" } }, "description" : "The type-specific properties of the tenant object returned" }, "tenant_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "example" : "tenant" }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "195798545063742726" }, "attributes" : { "$ref" : "#/components/schemas/tenant_data_attributes" } }, "description" : "The template for a resource object representing an Auvik tenant" }, "deviceDetailsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of device details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" }, "deviceDetailsAttributes_discoveryStatus" : { "properties" : { "snmp" : { "type" : "string", "example" : "disabled", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "login" : { "type" : "string", "example" : "disabled", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "wmi" : { "type" : "string", "example" : "disabled", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] }, "vmware" : { "type" : "string", "example" : "disabled", "enum" : [ "disabled", "determining", "notSupported", "notAuthorized", "authorizing", "authorized", "privileged" ] } }, "description" : "High level statuses of discovery services" }, "deviceDetailsRelationships_connectedDevices_attributes" : { "required" : [ "deviceName" ], "properties" : { "deviceName" : { "type" : "string", "description" : "Connected device's name", "example" : "SomeOtherDevice" } }, "description" : "The type-specific properties of the connected device object returned" }, "deviceDetailsRelationships_connectedDevices_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this connected device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112785923/dashboard" }, "self" : { "type" : "string", "description" : "Link to this connected device", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" } }, "description" : "Links relating to this connected device" }, "deviceDetailsRelationships_connectedDevices_data" : { "properties" : { "id" : { "type" : "string", "description" : "Connected device's ID", "example" : "MTk5NzYyMjM1MDE1MTY4MDA0LDE5OTc2MjQ4MzgzMjYxMjM1NQ" }, "attributes" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_connectedDevices_attributes" }, "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "device" ] }, "links" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_connectedDevices_links" } } }, "deviceDetailsRelationships_connectedDevices" : { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "description" : "A connected device resource object", "items" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_connectedDevices_data" } } }, "description" : "List of other devices connected to this device" }, "deviceDetailsRelationships_interfaces_attributes" : { "required" : [ "interfaceName", "macAddress" ], "properties" : { "interfaceName" : { "type" : "string", "description" : "This interface's name", "example" : "Interface 1" }, "macAddress" : { "type" : "string", "description" : "The MAC address of this interface", "example" : "10:dd:b1:cb:ab:c6" } }, "description" : "The type-specific properties of the interfaces object returned" }, "deviceDetailsRelationships_interfaces_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/interface/199502791112785923/dashboard" }, "self" : { "type" : "string", "description" : "Link to this interface", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" } }, "description" : "Links relating to this interface" }, "deviceDetailsRelationships_interfaces_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "interface" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a interface", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_interfaces_attributes" }, "links" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_interfaces_links" } } }, "deviceDetailsRelationships_interfaces" : { "properties" : { "data" : { "type" : "array", "description" : "An interface resource object", "items" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_interfaces_data" } } }, "description" : "This device's interfaces" }, "deviceDetailsRelationships_configurations_attributes" : { "required" : [ "backupTime", "isRunning" ], "properties" : { "isRunning" : { "type" : "boolean", "description" : "Whether the configuration is currently running" }, "backupTime" : { "type" : "string", "description" : "Last backup time of the configuration", "example" : "2018-03-12T12:00:00.000Z" } }, "description" : "The type-specific properties of the configuration object returned" }, "deviceDetailsRelationships_configurations_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this configuration", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" } }, "description" : "Links relating to this device's configuration" }, "deviceDetailsRelationships_configurations_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "configuration" ] }, "id" : { "type" : "string", "description" : "The unique identifier for the device associated to the configuration", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_configurations_attributes" }, "links" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_configurations_links" } } }, "deviceDetailsRelationships_configurations" : { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "description" : "A configuration resource object", "items" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_configurations_data" } } }, "description" : "This device's configurations" }, "deviceDetailsRelationships_components_attributes" : { "required" : [ "componentName", "componentType", "configurationId", "configurationIndex" ], "properties" : { "configurationId" : { "type" : "string", "deprecated" : true }, "configurationIndex" : { "type" : "string", "deprecated" : true }, "componentName" : { "type" : "string", "description" : "This component's name", "example" : "CPU Core 26" }, "componentType" : { "type" : "string", "description" : "This component's type", "example" : "cpu", "enum" : [ "cpu", "disk", "fan", "memory", "powerSupply", "storageController", "systemBoard" ] } }, "description" : "The type-specific properties of the component object returned" }, "deviceDetailsRelationships_components_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this component's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu" }, "self" : { "type" : "string", "description" : "Link to this component", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/components/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" } }, "description" : "Links relating to this component" }, "deviceDetailsRelationships_components_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "component" ] }, "id" : { "type" : "string", "description" : "The unique identifier for the component associated to the device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_components_attributes" }, "links" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_components_links" } } }, "deviceDetailsRelationships_components" : { "required" : [ "data" ], "properties" : { "data" : { "type" : "array", "description" : "A component resource object", "items" : { "$ref" : "#/components/schemas/deviceDetailsRelationships_components_data" } } }, "description" : "The components of a device" }, "deviceDetailsReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail?page[last]=300" } }, "description" : "Pagination related links" }, "deviceDetailsExtendedReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/detail/extended?page[last]=300" } }, "description" : "Pagination related links" }, "deviceExtendedDetailsDevice_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this device's extended details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/details/extended/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "info" : { "type" : "string", "description" : "Link to this device's device info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" }, "deviceWarrantyReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty?page[last]=300" } }, "description" : "Pagination related links" }, "deviceWarrantyResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this device", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/warranty/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" }, "deviceLifecycleReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle?page[last]=300" } }, "description" : "Pagination related links" }, "deviceLifecycleResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this device lifecyle record", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/lifecycle/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this device" }, "deviceLifecycleRelationships_device_data_attributes" : { "required" : [ "deviceName" ], "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "ESXi-H153.MSC.MGMT" } }, "description" : "The type-specific properties of the device object returned" }, "deviceLifecycleRelationships_device_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "device" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this device", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships_device_data_attributes" } }, "description" : "A device resource object" }, "deviceLifecycleRelationships_device" : { "properties" : { "data" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships_device_data" } }, "description" : "The device corresponding to this configuration" }, "configReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration?page[last]=300" } }, "description" : "Pagination related links" }, "configResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this configuration in Auvik dashboard", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791113028867/configurations" }, "self" : { "type" : "string", "description" : "Link to this configuration", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/configuration/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this configuration" }, "networkInfoReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info?page[last]=300" } }, "description" : "Pagination related links" }, "networksResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this network's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of network info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this network" }, "networkRelationships_networkDetail_data_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this set of network detail", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "dashboard" : { "type" : "string", "description" : "Link to this network's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard" } }, "description" : "Links relating to this network details" }, "networkRelationships_networkDetail_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "networkDetail" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this network", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "links" : { "$ref" : "#/components/schemas/networkRelationships_networkDetail_data_links" } }, "description" : "A network detail object" }, "networkRelationships_networkDetail" : { "properties" : { "data" : { "$ref" : "#/components/schemas/networkRelationships_networkDetail_data" } }, "description" : "Additional attributes and details relating to this network." }, "networkRelationships_devices_attributes" : { "required" : [ "deviceName" ], "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint" } }, "description" : "This device's attributes" }, "networkRelationships_devices_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this device", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "Links relating to this device" }, "networkRelationships_devices_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "device" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "attributes" : { "$ref" : "#/components/schemas/networkRelationships_devices_attributes" }, "links" : { "$ref" : "#/components/schemas/networkRelationships_devices_links" } } }, "networkRelationships_devices" : { "properties" : { "data" : { "type" : "array", "description" : "A device resource object", "items" : { "$ref" : "#/components/schemas/networkRelationships_devices_data" } } }, "description" : "This network's devices" }, "networkDetailsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this network's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/network/199502791112785923/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of network details", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this network" }, "networkDetailsReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/detail?page[last]=300" } }, "description" : "Pagination related links" }, "interfaceInfoReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info?page[last]=300" } }, "description" : "Pagination related links" }, "interfaceResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of interface info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMjg5NjAwMw" } }, "description" : "List of links relating to this interface" }, "interfaceRelationships_connectedTo_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of network info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ" } }, "description" : "Links relating to this interface" }, "interfaceRelationships_connectedTo_data" : { "properties" : { "id" : { "type" : "string", "description" : "This interface's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ" }, "type" : { "type" : "string", "description" : "The type of the object", "enum" : [ "interface" ] }, "links" : { "$ref" : "#/components/schemas/interfaceRelationships_connectedTo_links" } } }, "interfaceRelationships_connectedTo" : { "properties" : { "data" : { "type" : "array", "description" : "An interface resource object", "items" : { "$ref" : "#/components/schemas/interfaceRelationships_connectedTo_data" } } }, "description" : "List of other interfaces this interface is connected to" }, "interfaceRelationships_networks_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this network's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/network/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of network info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/network/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" } }, "description" : "Links relating to this network" }, "interfaceRelationships_networks_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of the object", "enum" : [ "network" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this network", "example" : "MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" }, "attributes" : { "$ref" : "#/components/schemas/deviceRelationships_networks_attributes" }, "links" : { "$ref" : "#/components/schemas/interfaceRelationships_networks_links" } } }, "interfaceRelationships_networks" : { "properties" : { "data" : { "type" : "array", "description" : "An network resource object", "items" : { "$ref" : "#/components/schemas/interfaceRelationships_networks_data" } } }, "description" : "This interface's networks" }, "interfaceRelationships_parentDevice_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of device info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "Links relating to this device" }, "interfaceRelationships_parentDevice_data" : { "properties" : { "id" : { "type" : "string", "description" : "This device's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "type" : { "type" : "string", "description" : "The type of the object", "enum" : [ "device" ] }, "links" : { "$ref" : "#/components/schemas/interfaceRelationships_parentDevice_data_links" } }, "description" : "A device resource object" }, "interfaceRelationships_parentDevice" : { "properties" : { "data" : { "$ref" : "#/components/schemas/interfaceRelationships_parentDevice_data" } }, "description" : "This interface's parent device" }, "componentInfoReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info?page[last]=300" } }, "description" : "Pagination related links" }, "componentsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this component's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/197769558351021318/cpu" }, "self" : { "type" : "string", "description" : "Link to this component", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" } }, "description" : "List of links relating to this component" }, "componentRelationships_parentDevice_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "device" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "attributes" : { "$ref" : "#/components/schemas/deviceLifecycleRelationships_device_data_attributes" } }, "description" : "A device resource object" }, "componentRelationships_parentDevice" : { "properties" : { "data" : { "$ref" : "#/components/schemas/componentRelationships_parentDevice_data" } }, "description" : "The device associated with this component" }, "entityNotesReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note?page[last]=300" } }, "description" : "Pagination related links" }, "noteResourceObject_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this entity note", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/note/MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA" } }, "description" : "List of links relating to this entity note" }, "entityAuditReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit?page[last]=300" } }, "description" : "Pagination related links" }, "auditsResourceObject_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this entity audit", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/entity/audit/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" } }, "description" : "List of links relating to this entity audit" }, "auditRelationships_device_data_attributes" : { "properties" : { "deviceName" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint" } }, "description" : "The type-specific properties of the device object returned" }, "auditRelationships_device_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "device" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "attributes" : { "$ref" : "#/components/schemas/auditRelationships_device_data_attributes" } }, "description" : "A device resource object" }, "auditRelationships_device" : { "properties" : { "data" : { "$ref" : "#/components/schemas/auditRelationships_device_data" } }, "description" : "This device associated with this audit log" }, "tenantsResourceObject_relationships_parent_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "tenant" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "0192837465" } }, "description" : "The parent tenant data object of the tenant selected" }, "tenantsResourceObject_relationships_parent" : { "properties" : { "data" : { "$ref" : "#/components/schemas/tenantsResourceObject_relationships_parent_data" } }, "description" : "The parent tenant container object of the tenant selected" }, "tenantsResourceObject_relationships" : { "properties" : { "parent" : { "$ref" : "#/components/schemas/tenantsResourceObject_relationships_parent" } }, "description" : "The type specific relationship of the tenants object to other entities" }, "tenantDetailResourceObject_relationships_parent_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "enum" : [ "tenants" ] }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "0192837465" } }, "description" : "The parent tenant data object of the tenant selected" }, "tenantDetailResourceObject_relationships_parent" : { "properties" : { "data" : { "$ref" : "#/components/schemas/tenantDetailResourceObject_relationships_parent_data" } }, "description" : "The parent tenant container object of the tenant selected" }, "tenantDetailResourceObject_relationships_authorizations_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of authorizations", "enum" : [ "authorizations" ] }, "id" : { "type" : "string", "description" : "The id is granted for authorization", "example" : "(55849,7923)" } } }, "tenantDetailResourceObject_relationships_authorizations" : { "properties" : { "data" : { "type" : "array", "description" : "The list of authorization to the tenant selected", "items" : { "$ref" : "#/components/schemas/tenantDetailResourceObject_relationships_authorizations_data" }, "x-omitempty" : false } }, "description" : "The The authorization container object of the tenant selected" }, "tenantDetailResourceObject_relationships" : { "properties" : { "parent" : { "$ref" : "#/components/schemas/tenantDetailResourceObject_relationships_parent" }, "authorizations" : { "$ref" : "#/components/schemas/tenantDetailResourceObject_relationships_authorizations" } }, "description" : "The type specific relationship of the legacy tenants object to other entities" }, "tenantDetailAttributes_address" : { "properties" : { "address1" : { "type" : "string", "description" : "Tenant's mailing address", "example" : "123 Some St." }, "address2" : { "type" : "string", "description" : "Additional address information", "example" : "Suite 321" }, "city" : { "type" : "string", "description" : "City tenant is located in", "example" : "Waterloo" }, "State/Province" : { "type" : "string", "description" : "State or region tenant is located in", "example" : "Ontario", "deprecated" : true }, "ZIP/PostalCode" : { "type" : "string", "description" : "Zip code or postal code of tenant's mailing address", "example" : "N1A 2B3", "deprecated" : true }, "state" : { "type" : "string", "description" : "State or region tenant is located in", "example" : "Ontario" }, "postalCode" : { "type" : "string", "description" : "Zip code or postal code of tenant's mailing address", "example" : "N1A 2B3" }, "country" : { "type" : "string", "description" : "Country tenant is located in", "example" : "Canada" } }, "description" : "Address of the tenant" }, "alertHistoryInfoReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/alert/history/info?page[last]=300" } }, "description" : "Pagination related links" }, "alertsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this alert's dashboard in the Auvik UI", "example" : "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807" }, "self" : { "type" : "string", "description" : "Link to this alert", "example" : "https://auvikapi.us1.my.auvik.com/v1/alert/history/info/MTk5NTAyNzg2ODc3MDYzMTY5LDE5OTUwMjc5MTExMjc4NTkyMw" } }, "description" : "List of links relating to this alert" }, "alertAttributes_externalTicket" : { "properties" : { "id" : { "type" : "string", "description" : "The unique identifier for the external ticket", "example" : "56003" }, "system" : { "type" : "string", "description" : "The system of external ticket", "example" : "Connectwise_Cloud", "enum" : [ "All_User_Email", "Single_User_Email", "Custom_Email", "Slack", "Connectwise_Cloud", "Connectwise_Premise", "Freshdesk", "Autotask", "Map", "Custom_Email_Group", "Webhook", "Microsoft_Teams", "Continum", "Connectwise_rest_Cloud", "Servicenow" ] } } }, "alertRelationships_relatedAlert_data_attributes" : { "properties" : { "name" : { "type" : "string", "description" : "The name of related alert", "example" : "High Storage Utilization Cleared" } }, "description" : "The attribute of the related alert" }, "alertRelationships_relatedAlert_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's dashboard in the Auvik UI", "example" : "https://sampledomain.my.auvik.com/#entity/root/alerts/details/alert/382919292406038807" }, "self" : { "type" : "string", "description" : "Link to this alert info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ" } }, "description" : "Links relating to this interface" }, "alertRelationships_relatedAlert_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the api", "enum" : [ "alert" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this alert", "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA" }, "attributes" : { "$ref" : "#/components/schemas/alertRelationships_relatedAlert_data_attributes" }, "links" : { "$ref" : "#/components/schemas/alertRelationships_relatedAlert_data_links" } }, "description" : "This alert associated to the related alert" }, "alertRelationships_relatedAlert" : { "properties" : { "data" : { "$ref" : "#/components/schemas/alertRelationships_relatedAlert_data" } }, "description" : "The related alert linked to the current one" }, "alertRelationships_entity_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's dashboard in the Auvik UI", "example" : "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of network info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/MTk5NTAyNzg2ODc3MDYzNjgxLDE5OTUwMzc3Nzk1Njg4ODgzNQ" } }, "description" : "Links relating to this entity" }, "alertRelationships_entity_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the api", "enum" : [ "interface", "device", "network" ] }, "id" : { "type" : "string", "description" : "The unique identifier for this entity", "example" : "MTg2OTI2NTY1MDQ3MDExMDc0LDE5Nzc2OTU1ODM1MTAyMTMxOA" }, "links" : { "$ref" : "#/components/schemas/alertRelationships_entity_data_links" } }, "description" : "An entity resource object" }, "alertRelationships_entity" : { "properties" : { "data" : { "$ref" : "#/components/schemas/alertRelationships_entity_data" } }, "description" : "This entity associated to the alert message" }, "clientUsageResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to the billing usage dashboard in the Auvik UI.", "example" : "https://sampledomain.my.auvik.com/#admin/settings/billingUsage" }, "tenantRecord" : { "type" : "string", "description" : "Link to this client's record in the Tenants API", "example" : "https://auvikapi.us1.my.auvik.com/v1/tenants/detail/199762235015168516?tenantDomainPrefix=sampledomain" }, "self" : { "type" : "string", "description" : "Link to this client's usage in the Usage API", "example" : "https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168516&from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this client's usage" }, "clientUsageAttributes_monitoredWorkstations" : { "properties" : { "date" : { "type" : "string", "description" : "The date for the monitoring data", "example" : "2025-01-01" }, "totalEndpoints" : { "type" : "number", "description" : "The number of monitored workstation on the given day", "example" : 1 } } }, "clientUsageAttributes_monitoredServers" : { "properties" : { "date" : { "type" : "string", "description" : "The date for the monitoring data", "example" : "2025-01-01" }, "totalServers" : { "type" : "number", "description" : "The number of monitored servers on the given day", "example" : 2 } } }, "clientUsageAttributes_usagePeriod" : { "properties" : { "startDate" : { "type" : "string", "description" : "Date and time the usage period starts", "example" : "2019-06-01T00:00:00Z" }, "endDate" : { "type" : "string", "description" : "Date and time the usage period ends", "example" : "2019-07-01T00:00:00Z" }, "lengthInDays" : { "type" : "number", "description" : "Number of days in the usage period", "example" : 30 } }, "description" : "Description of the usage period that's been asked for" }, "clientUsageAttributes_deviceUsage_totalDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Billable devices days for devices on a client with no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Billable devices days for devices on a client set to Light", "example" : 30 }, "essentials" : { "type" : "number", "description" : "Billable devices days for devices on a client set to Essentials", "example" : 30 }, "performance" : { "type" : "number", "description" : "Billable devices days for devices on a client set to Performance", "example" : 120 } }, "description" : "The total billable device days for this client and all of its children across the usage period, separate by devices' owning client type" }, "clientUsageAttributes_deviceUsage_averageDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Average billable devices days for devices on a client with no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Average billable devices days for devices on a client set to Light", "example" : 1 }, "essentials" : { "type" : "number", "description" : "Average billable devices days for devices on a client set to Essentials", "example" : 1 }, "performance" : { "type" : "number", "description" : "Average billable devices days for devices on a client set to Performance", "example" : 4 } }, "description" : "The average billable device days for this client and all of its children across the usage period, separate by devices' owning client type" }, "clientUsageAttributes_deviceUsage" : { "properties" : { "totalDays" : { "type" : "number", "description" : "The total billable device days for this client and all of its children across the usage period", "example" : 150 }, "averageDays" : { "type" : "number", "description" : "The average billable device days for this client and all of its children across the usage period", "example" : 5 }, "totalDaysByClientType" : { "$ref" : "#/components/schemas/clientUsageAttributes_deviceUsage_totalDaysByClientType" }, "averageDaysByClientType" : { "$ref" : "#/components/schemas/clientUsageAttributes_deviceUsage_averageDaysByClientType" } }, "description" : "Roll up of device usage on this client (and its children if a multi-client)" }, "clientUsageAttributes_clientUsage_totalDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Billable client days for clients with no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Billable client days for clients set to Light", "example" : 30 }, "essentials" : { "type" : "number", "description" : "Billable client days for clients set to Essentials", "example" : 30 }, "performance" : { "type" : "number", "description" : "Billable client days for clients set to Performance", "example" : 120 } }, "description" : "The total billable client days for this client and all of its children across the usage period, by client type, starting on April 1st, 2021" }, "clientUsageAttributes_clientUsage_averageDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Average billable client days for clients with no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Average billable client days for clients set to Light", "example" : 1 }, "essentials" : { "type" : "number", "description" : "Average billable client days for clients set to Essentials", "example" : 1 }, "performance" : { "type" : "number", "description" : "Average billable client days for clients set to Performance", "example" : 4 } }, "description" : "The average billable client days for this client and all of its children across the usage period, by client type, starting on April 1st, 2021" }, "clientUsageAttributes_clientUsage" : { "properties" : { "totalDays" : { "type" : "number", "description" : "Total billable client days for this client (and its children) across the usage period", "example" : 150 }, "averagedDays" : { "type" : "number", "description" : "Average billable client days for this client (and its children) across the usage period", "example" : 5 }, "totalDaysByClientType" : { "$ref" : "#/components/schemas/clientUsageAttributes_clientUsage_totalDaysByClientType" }, "averageDaysByClientType" : { "$ref" : "#/components/schemas/clientUsageAttributes_clientUsage_averageDaysByClientType" } }, "description" : "Roll up of client usage for this client (and its children if a multi-client)" }, "clientUsageAttributes_asmUserUsage" : { "properties" : { "totalAsmUsers" : { "type" : "number", "description" : "Total billable ASM users for this client across the usage period", "example" : 150 } }, "description" : "Roll up of ASM user usage for this client assigned to the passed ANM tenant" }, "clientUsageRelationships_devices_attributes" : { "properties" : { "name" : { "type" : "string", "description" : "Device's name", "example" : "MyAccessPoint" }, "totalDays" : { "type" : "number", "description" : "Total billable days for this device across the usage period", "example" : 30 }, "clientName" : { "type" : "string", "description" : "This device's owning client's name/domainPrefix", "example" : "sampledomain" } }, "description" : "The type-specific properties of the device usage object returned" }, "clientUsageRelationships_devices_links" : { "properties" : { "deviceRecord" : { "type" : "string", "description" : "Link to this device's record in the Device Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "self" : { "type" : "string", "description" : "Link to this device's usage in the Usage API", "example" : "https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this device's usage" }, "clientUsageRelationships_devices_data" : { "properties" : { "id" : { "type" : "string", "description" : "Device's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "deviceUsage" ] }, "attributes" : { "$ref" : "#/components/schemas/clientUsageRelationships_devices_attributes" }, "links" : { "$ref" : "#/components/schemas/clientUsageRelationships_devices_links" } } }, "clientUsageRelationships_devices" : { "properties" : { "data" : { "type" : "array", "description" : "A device's usage for the given usage period", "items" : { "$ref" : "#/components/schemas/clientUsageRelationships_devices_data" } } }, "description" : "List of billable device usage under this client" }, "clientUsageRelationships_clients_attributes" : { "properties" : { "domainPrefix" : { "type" : "string", "description" : "Client tenant's domain prefix/name", "example" : "mspclient" }, "totalBillableDays" : { "type" : "number", "description" : "Total billable days for this client across the usage period", "example" : 30 } }, "description" : "The type-specific properties of the device usage object returned" }, "clientUsageRelationships_clients_links" : { "properties" : { "self" : { "type" : "string", "description" : "Link to this client's usage in the Usage API", "example" : "https://auvikapi.us1.my.auvik.com/v1/billing/usage/client?tenants=199762235015168004&from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this client's usage" }, "clientUsageRelationships_clients_data" : { "properties" : { "id" : { "type" : "string", "description" : "Client's ID", "example" : "199762235015168004" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "clientUsage" ] }, "attributes" : { "$ref" : "#/components/schemas/clientUsageRelationships_clients_attributes" }, "links" : { "$ref" : "#/components/schemas/clientUsageRelationships_clients_links" } } }, "clientUsageRelationships_clients" : { "properties" : { "data" : { "type" : "array", "description" : "A client's usage for the given usage period", "items" : { "$ref" : "#/components/schemas/clientUsageRelationships_clients_data" } } }, "description" : "List of clients' usage (if any) under this client" }, "clientUsageRelationships_asmUsers_data" : { "properties" : { "id" : { "type" : "string", "description" : "ASM user's ID", "example" : "23713fd9-60e2-4a25-b4a9-e8492603cfxa" } } }, "clientUsageRelationships_asmUsers" : { "properties" : { "data" : { "type" : "array", "description" : "An ASM user's usage for the given usage period", "items" : { "$ref" : "#/components/schemas/clientUsageRelationships_asmUsers_data" } } }, "description" : "List of ASM users' usage (if any) under this client assigned to the passed ANM tenant" }, "deviceUsageResourceObject_links" : { "properties" : { "deviceRecord" : { "type" : "string", "description" : "Link to this device's record in the Device Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "self" : { "type" : "string", "description" : "Link to this device's usage in the Usage API", "example" : "https://auvikapi.us1.my.auvik.com/v1/billing/usage/device/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this client's usage" }, "deviceUsageAttributes_totalDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Billable devices days for the device when its client had no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Billable devices days for the device when its client was set to Light", "example" : 0 }, "essentials" : { "type" : "number", "description" : "Billable devices days for the device when its client was set to Essentials", "example" : 6 }, "performance" : { "type" : "number", "description" : "Billable devices days for the device when its client was set to Performance", "example" : 24 } }, "description" : "The total billable device days for across the usage period, separate by this device's owning client type" }, "deviceUsageAttributes_averageDaysByClientType" : { "properties" : { "notier" : { "type" : "number", "description" : "Average billable devices days for the device when its client had no set client type", "example" : 0 }, "light" : { "type" : "number", "description" : "Average billable devices days for the device when its client was set to Light", "example" : 0 }, "essentials" : { "type" : "number", "description" : "Average billable devices days for the device when its client was set to Essentials", "example" : 0.2 }, "performance" : { "type" : "number", "description" : "Average billable devices days for the device when its client was set to Performance", "example" : 0.8 } }, "description" : "The average billable device days for all clients across the usage period, separate by devices' owning client type" }, "deviceUsageRelationships_client_data_attributes" : { "properties" : { "domainPrefix" : { "type" : "string", "description" : "Client tenant's domain prefix/name", "example" : "mspclient" } }, "description" : "The type-specific properties of the device usage object returned" }, "deviceUsageRelationships_client_data" : { "properties" : { "id" : { "type" : "string", "description" : "Client's ID", "example" : "199762235015168004" }, "type" : { "type" : "string", "description" : "The type of this resource object", "enum" : [ "clientUsage" ] }, "attributes" : { "$ref" : "#/components/schemas/deviceUsageRelationships_client_data_attributes" }, "links" : { "$ref" : "#/components/schemas/clientUsageResourceObject_links" } } }, "deviceUsageRelationships_client" : { "properties" : { "data" : { "$ref" : "#/components/schemas/deviceUsageRelationships_client_data" } }, "description" : "Client who owns this device and whose usage this device contributes to." }, "deviceStatisticsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this device's record in the Device Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "self" : { "type" : "string", "description" : "Link used to get this result set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/device/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this device statistics" }, "deviceStatisticsRelationships_device_data" : { "properties" : { "id" : { "type" : "string", "description" : "This device's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "type" : { "type" : "string", "description" : "The type of the object", "example" : "device" }, "deviceName" : { "type" : "string", "description" : "The name of the device", "example" : "sw-1138" }, "deviceType" : { "type" : "string", "description" : "The type of the device", "example" : "switch" }, "links" : { "$ref" : "#/components/schemas/interfaceRelationships_parentDevice_data_links" } }, "description" : "A device resource object" }, "deviceStatisticsRelationships_device" : { "properties" : { "data" : { "$ref" : "#/components/schemas/deviceStatisticsRelationships_device_data" } }, "description" : "This device the statistics are reported against" }, "serviceStatisticsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this service's record in the Service Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/service/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "self" : { "type" : "string", "description" : "Link used to get this result set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/service/bandwidth/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to the service statistics" }, "serviceStatisticsRelationships_service_data_attributes" : { "properties" : { "serviceName" : { "type" : "string", "description" : "A description of the service", "example" : "Internet Connection Check" } }, "description" : "The type-specific properties of the service" }, "serviceStatisticsRelationships_service_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this service's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/service/199502791112896003/dashboard" } }, "description" : "Links relating to this service" }, "serviceStatisticsRelationships_service_data" : { "properties" : { "type" : { "type" : "string", "description" : "The entity type for a service", "example" : "service" }, "attributes" : { "$ref" : "#/components/schemas/serviceStatisticsRelationships_service_data_attributes" }, "links" : { "$ref" : "#/components/schemas/serviceStatisticsRelationships_service_data_links" } }, "description" : "A service resource object" }, "serviceStatisticsRelationships_service" : { "properties" : { "data" : { "$ref" : "#/components/schemas/serviceStatisticsRelationships_service_data" } }, "description" : "This service the statistics are reported against" }, "interfaceStatisticsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interface's record in the Interface Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" }, "self" : { "type" : "string", "description" : "Link used to get this result set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/interface/bandwidth/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this interface statistics" }, "interfaceStatisticsRelationships_interface_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this interfaces's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/interface/199502791112896003/dashboard" }, "parentDevice" : { "type" : "string", "description" : "Link to this interfaces's parent device dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of interface info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/interface/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" } }, "description" : "Links relating to this interface" }, "interfaceStatisticsRelationships_interface_data" : { "properties" : { "id" : { "type" : "string", "description" : "This interface's ID", "example" : "NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" }, "type" : { "type" : "string", "description" : "The type of the object", "example" : "device" }, "interfaceName" : { "type" : "string", "description" : "This interface's name", "example" : "Interface 1" }, "interfaceType" : { "type" : "string", "description" : "This interface's type", "example" : "ethernet" }, "parentDevice" : { "type" : "string", "description" : "This interface's parent device", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "links" : { "$ref" : "#/components/schemas/interfaceStatisticsRelationships_interface_data_links" } }, "description" : "A interface resource object" }, "interfaceStatisticsRelationships_interface" : { "properties" : { "data" : { "$ref" : "#/components/schemas/interfaceStatisticsRelationships_interface_data" } }, "description" : "This interface the statistics are reported against" }, "componentStatisticsResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this component's record in the Component Info API", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" }, "self" : { "type" : "string", "description" : "Link used to get this result set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/component/cpu/latency/MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA?from=2019-06-01&to=2019-06-30" } }, "description" : "Links relating to this component statistics" }, "componentStatisticsRelationships_component_data_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this component's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/component/199502791112896003/dashboard" }, "parentDevice" : { "type" : "string", "description" : "Link to this component's parent device dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/device/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this set of component info", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/component/info/NzkyMywzNzE1NjcxOTI2MTE0MjI5MDE" } }, "description" : "Links relating to this component" }, "componentStatisticsRelationships_component_data" : { "properties" : { "id" : { "type" : "string", "description" : "This component's ID", "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, "type" : { "type" : "string", "description" : "The type of the object", "example" : "device" }, "componentName" : { "type" : "string", "description" : "This component's name", "example" : "Component 1" }, "componentType" : { "type" : "string", "description" : "This component's type", "example" : "cpu" }, "parentDevice" : { "type" : "string", "description" : "This component's parent device", "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA" }, "links" : { "$ref" : "#/components/schemas/componentStatisticsRelationships_component_data_links" } }, "description" : "A component resource object" }, "componentStatisticsRelationships_component" : { "properties" : { "data" : { "$ref" : "#/components/schemas/componentStatisticsRelationships_component_data" } }, "description" : "This component the statistics are reported against" }, "deviceOidMonitorRead_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info?page[last]=300" } }, "description" : "Pagination related links" }, "deviceOidMonitorResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this OID's dashboard in Auvik", "example" : "https://sampledomain.my.auvik.com/#entity/oid/199502791112896003/dashboard" }, "self" : { "type" : "string", "description" : "Link to this OID", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/oid/info/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" } }, "description" : "List of links relating to this OID" }, "oidRelationships_device_data" : { "properties" : { "id" : { "type" : "string", "description" : "This device's ID", "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "type" : { "type" : "string", "description" : "The type of the object", "enum" : [ "device" ] }, "deviceType" : { "type" : "string", "description" : "The type of the device", "example" : "switch" }, "deviceName" : { "type" : "string", "description" : "The name of the device", "example" : "sw-1138" }, "links" : { "$ref" : "#/components/schemas/interfaceRelationships_parentDevice_data_links" } }, "description" : "A device resource object" }, "oidRelationships_device" : { "properties" : { "data" : { "$ref" : "#/components/schemas/oidRelationships_device_data" } }, "description" : "This OID's device" }, "snmpPollerSettingsRead_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/setting/snmppoller?page[last]=300" } }, "description" : "Pagination related links" }, "snmpPollerSettingDevicesRead_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/settings/snmppoller/MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw/devices?page[last]=300" } }, "description" : "Pagination related links" }, "snmpPollerSettingDeviceResourceObject_links" : { "properties" : { "dashboard" : { "type" : "string", "description" : "Link to this Device's dashboard in Auvik", "example" : "http://office.local.auvik.com:9000/#entity/device/7798604142709656/dashboard" }, "self" : { "type" : "string", "description" : "Link to this OID", "example" : "https://auvikapi.us1.my.auvik.com/v1/inventory/device/info/NzkyMyw3Nzk4NjA0MTQyNzA5NjU2MzE=" } }, "description" : "List of links relating to this OID" }, "snmpPollerSetting_data_attributes" : { "properties" : { "name" : { "type" : "string", "description" : "SNMP Poller Setting name", "example" : "Cisco CPU Usage", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "SNMP Poller Setting Name" }, "protocol" : { "type" : "string", "description" : "Protocol", "enum" : [ "snmp" ], "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Protocol" }, "oid" : { "type" : "string", "description" : "OID identifier", "example" : "1.3.6.1.4.1.17373.4.1.2.1.5.1", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID identifier" }, "type" : { "type" : "string", "description" : "SNMP Poller Setting type", "example" : "string", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "OID Type" }, "useAs" : { "type" : "string", "description" : "Underlying use of this poller (serialNo, poller)", "example" : "poller", "x-isRequired" : false, "x-isFilter" : false, "x-label" : "Use as" } }, "description" : "The type-specific properties of the tenant object returned" }, "snmpPollerSetting_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "example" : "snmpPollerSetting" }, "id" : { "type" : "string", "description" : "The unique identifier for a SNMP Poller Setting", "example" : "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ" }, "attributes" : { "$ref" : "#/components/schemas/snmpPollerSetting_data_attributes" }, "links" : { "$ref" : "#/components/schemas/deviceOidMonitorResourceObject_links" } }, "description" : "The type-specific properties of the SNMP Poller's object returned" }, "snmpPollerStringHistoryRead_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=300" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[before]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[last]=300" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/string?page[last]=300" } }, "description" : "Pagination related links" }, "snmpPollerStringHistoryAttributes_reportPeriod" : { "properties" : { "fromTime" : { "type" : "string", "description" : "Start timestamp for the query", "example" : "2020-02-18T00:00:00.000Z", "x-isFilter" : true }, "thruTime" : { "type" : "string", "description" : "End timestamp for the query", "example" : "2020-02-19T00:00:00.000Z", "x-isFilter" : true } }, "description" : "Reporting period for the returned historical values" }, "snmpPollerSettingReduced_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "example" : "snmpPollerSetting" }, "id" : { "type" : "string", "description" : "The unique identifier for a SNMP Poller Setting", "example" : "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ" }, "links" : { "$ref" : "#/components/schemas/deviceOidMonitorResourceObject_links" } }, "description" : "The type-specific properties of the SNMP Poller's object returned" }, "device_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "example" : "device" }, "id" : { "type" : "string", "description" : "The unique identifier for a Device", "example" : "NzkyMyw3NDk0MDU3ODI5NjQ5NjIzMTAsMQ" } }, "description" : "The type-specific properties of the SNMP Poller's Device object returned" }, "tenantReduced_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API.", "example" : "tenant" }, "id" : { "type" : "string", "description" : "The unique identifier for a tenant", "example" : "195798545063742726" } }, "description" : "The template for a resource object representing an Auvik tenant" }, "snmpPollerIntHistoryRead_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int/?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int/?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/stat/snmppoller/int?page[last]=300" } }, "description" : "Pagination related links" }, "appReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/apps?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/apps?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/apps?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/apps?page[last]=300" } }, "description" : "Pagination related links" }, "asmAppRelationships_breaches_attributes" : { "required" : [ "id", "type" ], "properties" : { "dateAdded" : { "type" : "string", "description" : "The data the breach was added", "example" : "2022-07-14T20:57:46.689Z" }, "severityScore" : { "type" : "string", "description" : "The severity of the breach", "example" : "6.5" }, "description" : { "type" : "string", "description" : "The description of the breach.", "example" : "GitHub discovered the breach on April 12, when the attacker accessed GitHub's npm production infrastructure, and disclosed the breach three days later.\n\nAlong with Heroku and Travis CI, GitHub has revoked all OAuth tokens to block further access, while still advising affected organizations to keep monitoring for suspicious activity." } }, "description" : "The type-specific properties of the interfaces object returned" }, "asmAppRelationships_breaches_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmBreach" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM breach", "example" : "d73b6c08-32ff-4934-846b-8c9725c223fa" }, "attributes" : { "$ref" : "#/components/schemas/asmAppRelationships_breaches_attributes" } } }, "asmAppRelationships_breaches" : { "properties" : { "data" : { "type" : "array", "description" : "An array of ASM breach objects", "items" : { "$ref" : "#/components/schemas/asmAppRelationships_breaches_data" } } }, "description" : "This application's breaches" }, "asmAppRelationships_contracts_attributes" : { "properties" : { "applicationId" : { "type" : "string", "description" : "The unique identifier of the application associated with the contract", "example" : "296c0d36-ed60-4021-8567-7e999e31919c" }, "daysBefore" : { "type" : "number", "description" : "The number of days before the contract expires", "example" : 7 }, "nrc" : { "type" : "string", "description" : "The non-recurring charge of the contract.", "example" : "914.00" }, "mrr" : { "type" : "string", "description" : "The monthly recurring revenue of the contract.", "example" : "403.76" }, "users" : { "type" : "number", "description" : "The number of users affected by the contract.", "example" : 49 }, "tcv" : { "type" : "string", "description" : "The total value of the contract.", "example" : "5759.12" }, "alerting" : { "type" : "boolean", "description" : "Whether or not alerts have been configured for this contract.", "example" : false }, "notes" : { "type" : "string", "description" : "Notes related to the contract.", "example" : "Proactively formulate sustainable systems, to fungibly foster leading-edge e-tailers, and efficiently fashion scalable data. " }, "type" : { "type" : "string", "description" : "The contract type.", "example" : "renew" }, "renewalDate" : { "type" : "string", "description" : "The date on which the contract renews.", "example" : "2025-03-19T05:33:43.044Z" }, "platformTenantId" : { "type" : "string", "description" : "The unique identifier of the client associated with this contract", "example" : "296c0d36-ed60-4021-8567-7e999e31919c" } }, "description" : "The type-specific properties of the interfaces object returned" }, "asmAppRelationships_contracts_data" : { "required" : [ "id", "type" ], "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmContract" ] }, "id" : { "type" : "string", "description" : "The unique identifier for the contract", "example" : "e040c79a-e5bd-4eb1-8af2-3a8364492d15" }, "attributes" : { "$ref" : "#/components/schemas/asmAppRelationships_contracts_attributes" } }, "description" : "The template for a resource object representing an ASM contract." }, "asmAppRelationships_contracts" : { "properties" : { "data" : { "type" : "array", "description" : "An array of ASM contract objects", "items" : { "$ref" : "#/components/schemas/asmAppRelationships_contracts_data" } } }, "description" : "This application's contracts" }, "asmAppRelationships_users_attributes_accounts" : { "properties" : { "username" : { "type" : "string", "description" : "The username associated with this account", "example" : "noah.barnes@example.com" }, "login" : { "type" : "boolean", "description" : "Whether or not any login activities have been detected with this account", "example" : true }, "azureSignInActivity" : { "type" : "boolean", "description" : "Whether or not there is any Azure sign in activity related to this account", "example" : false }, "googleSSO" : { "type" : "boolean", "description" : "Whether or not this account has been detected using Google SSO", "example" : false }, "microsoftSSO" : { "type" : "boolean", "description" : "Whether or not this account has been detected using Microsoft SSO", "example" : false }, "googleSignInActivity" : { "type" : "boolean", "description" : "Whether or not there is any Google Workspace sign in activity related to this account", "example" : false }, "lastUsed" : { "type" : "string", "description" : "The date this account was last used", "example" : "2024-10-10T09:24:50.113Z" }, "personal" : { "type" : "boolean", "description" : "Whether or not this is a personal account", "example" : false }, "work" : { "type" : "boolean", "description" : "Whether or not this is a work account", "example" : false }, "service" : { "type" : "boolean", "description" : "Whether or not this account is related to a service", "example" : false }, "shared" : { "type" : "boolean", "description" : "Whether or not this account is shared between multiple users", "example" : false } }, "description" : "The template for a resource object representing an ASM user account." }, "asmAppRelationships_users_attributes" : { "required" : [ "id", "type" ], "properties" : { "name" : { "type" : "string", "description" : "The name of this User", "example" : "john.doe@example.com" }, "username" : { "type" : "string", "description" : "The username of this User", "example" : "john.doe" }, "firstName" : { "type" : "string", "description" : "The first name of this User", "example" : "John" }, "lastName" : { "type" : "string", "description" : "The last name of this User", "example" : "Doe" }, "email" : { "type" : "string", "description" : "The email of this User", "example" : "johndoe@example.com" }, "dateAdded" : { "type" : "string", "description" : "The date this User was added", "example" : "2024-09-04T05:32:36.480Z" }, "disabled" : { "type" : "boolean", "description" : "Whether or not this User is disabled", "example" : false }, "expired" : { "type" : "boolean", "description" : "Whether or not this User is expired", "example" : false }, "active" : { "type" : "boolean", "description" : "Whether or not this User is active", "example" : true }, "personal" : { "type" : "boolean", "description" : "Whether or not this User is using a personal account", "example" : true }, "work" : { "type" : "boolean", "description" : "Whether or not this User is using a work account", "example" : true }, "lastUsed" : { "type" : "string", "description" : "The last date activity was detected for this User", "example" : "2024-09-04T05:32:36.480Z" }, "accounts" : { "type" : "array", "description" : "This User's accounts", "items" : { "$ref" : "#/components/schemas/asmAppRelationships_users_attributes_accounts" } } }, "description" : "The type-specific properties of the interfaces object returned" }, "asmAppRelationships_users_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmAppUser" ] }, "id" : { "type" : "string", "description" : "The unique identifier for the user", "example" : "e040c79a-e5bd-4eb1-8af2-3a8364492d15" }, "attributes" : { "$ref" : "#/components/schemas/asmAppRelationships_users_attributes" } }, "description" : "The template for a resource object representing an ASM application user." }, "asmAppRelationships_users" : { "properties" : { "data" : { "type" : "array", "description" : "An array of ASM user objects", "items" : { "$ref" : "#/components/schemas/asmAppRelationships_users_data" } } }, "description" : "This application's users" }, "asmAppRelationships_client_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmClient" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM client", "example" : "003a59d7-8498-4200-9f9c-646d8a39e41c" } } }, "asmAppRelationships_client" : { "properties" : { "data" : { "$ref" : "#/components/schemas/asmAppRelationships_client_data" } }, "description" : "This security log's associated client" }, "clientReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/clients?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/clients?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/clients?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/clients?page[last]=300" } }, "description" : "Pagination related links" }, "asmClientAttributes_totals" : { "properties" : { "users" : { "type" : "number", "example" : 1, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Total Users" }, "breaches" : { "type" : "number", "example" : 1, "x-isRequired" : true, "x-isFilter" : false, "x-label" : "Total Breaches" } }, "description" : "Totals" }, "securityLogReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/tags?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/tags?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/tags?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/tags?page[last]=300" } }, "description" : "Pagination related links" }, "asmSecurityLogRelationships_application_data_attributes" : { "required" : [ "id", "type" ], "properties" : { "name" : { "type" : "string", "description" : "The name of the application", "example" : "ShareFile" }, "risk" : { "type" : "string", "description" : "The risk level of this application", "example" : "Critical" } }, "description" : "The type-specific properties of the application object returned" }, "asmSecurityLogRelationships_application_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmApp" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM application", "example" : "fdc4d385-d4f8-462b-a28a-e7f598562840" }, "attributes" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_application_data_attributes" } } }, "asmSecurityLogRelationships_application" : { "properties" : { "data" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_application_data" } }, "description" : "This security log's application" }, "asmSecurityLogRelationships_user_data_attributes" : { "required" : [ "id", "type" ], "properties" : { "firstName" : { "type" : "string", "description" : "The first name of the user", "example" : "Nicole" }, "lastName" : { "type" : "string", "description" : "The last name of the user", "example" : "Jimenez" } }, "description" : "The type-specific properties of the user object returned" }, "asmSecurityLogRelationships_user_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmUser" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM user", "example" : "003a59d7-8498-4200-9f9c-646d8a39e41c" }, "attributes" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_user_data_attributes" } } }, "asmSecurityLogRelationships_user" : { "properties" : { "data" : { "$ref" : "#/components/schemas/asmSecurityLogRelationships_user_data" } }, "description" : "This security log's associated user" }, "userReadMultiple_links" : { "properties" : { "next" : { "type" : "string", "description" : "Next page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/users?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "prev" : { "type" : "string", "description" : "Previous page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/users?page[after]=Y3Vyc29yOk16TXpPVE0wT0RRNU1UQTROemN4TlRneExETXpNemt6TkRnME56QXpORFF5TmpFeU5R&page[first]=100" }, "first" : { "type" : "string", "description" : "First page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/users?page[first]=300" }, "last" : { "type" : "string", "description" : "Last page in the data set", "example" : "https://auvikapi.us1.my.auvik.com/v1/asm/users?page[last]=300" } }, "description" : "Pagination related links" }, "asmUserRelationships_applications_attributes" : { "required" : [ "id", "type" ], "properties" : { "dateAdded" : { "type" : "string", "description" : "The date the application was added", "example" : "2024-10-10T05:23:54.240Z" }, "name" : { "type" : "string", "description" : "The name of the application", "example" : "Microsoft Project" }, "usage" : { "type" : "number", "description" : "The amount of usage this user has used the application", "example" : 50 } }, "description" : "The type-specific properties of the application object returned" }, "asmUserRelationships_applications_data" : { "properties" : { "type" : { "type" : "string", "description" : "The type of object in the API", "enum" : [ "asmApp" ] }, "id" : { "type" : "string", "description" : "The unique identifier for an ASM application", "example" : "6e66dc01-6209-4cad-b3f8-ceb254eff400" }, "attributes" : { "$ref" : "#/components/schemas/asmUserRelationships_applications_attributes" } } }, "asmUserRelationships_applications" : { "properties" : { "data" : { "type" : "array", "description" : "An array of ASM application objects", "items" : { "$ref" : "#/components/schemas/asmUserRelationships_applications_data" } } }, "description" : "This user's applications" } }, "responses" : { "BadRequestResponse" : { "description" : "Bad request", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "ForbiddenResponse" : { "description" : "Forbidden", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "NotFoundResponse" : { "description" : "Not found", "content" : { "application/vnd.api+json" : { "schema" : { "$ref" : "#/components/schemas/basicError" } } } }, "ServerErrorResponse" : { "description" : "Something went wrong" } }, "parameters" : { "tenants" : { "name" : "tenants", "in" : "query", "description" : "Comma delimited list of tenant IDs to request info from.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "199762235015168516,199762235015168004" }, "devicePathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of device", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "deviceTypeFilterParam" : { "name" : "filter[deviceType]", "in" : "query", "description" : "Filter by device type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "$ref" : "#/components/schemas/DeviceTypeSchema" }, "example" : "accessPoint" }, "deviceIdFilterParam" : { "name" : "filter[deviceId]", "in" : "query", "description" : "Filter by device ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "includeDeviceDetailParam" : { "name" : "include", "in" : "query", "description" : "Use to include the full resource objects of the list device relationships.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "deviceDetail" ] }, "example" : "deviceDetail" }, "deviceDetailFieldsParam" : { "name" : "fields[deviceDetail]", "in" : "query", "description" : "Use to limit the attributes that will be returned in the included detail object to only what is specified by this query parameter. Requires include=deviceDetail", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "discoveryStatus", "components", "connectedDevices", "configurations", "manageStatus", "interfaces" ] }, "example" : "discoveryStatus,components" }, "interfaceTypeFilterParam" : { "name" : "filter[interfaceType]", "in" : "query", "description" : "Filter by interface type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "ethernet", "wifi", "bluetooth", "cdma", "coax", "cpu", "distributedVirtualSwitch", "firewire", "gsm", "ieee8023AdLag", "inferredWired", "inferredWireless", "interface", "linkAggregation", "loopback", "modem", "wimax", "optical", "other", "parallel", "ppp", "radiomac", "rs232", "tunnel", "unknown", "usb", "virtualBridge", "virtualNic", "virtualSwitch", "vlan" ] }, "example" : "ethernet" }, "interfaceIdFilterParam" : { "name" : "filter[interfaceId]", "in" : "query", "description" : "Filter by interface ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, "networkPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of network", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "networkTypeFilterParam" : { "name" : "filter[networkType]", "in" : "query", "description" : "Filter by network type.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "routed", "vlan", "wifi", "loopback", "network", "layer2", "internet" ] }, "example" : "routed" }, "networkScanStatusFilterParam" : { "name" : "filter[scanStatus]", "in" : "query", "description" : "Filter by the network’s scan status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "true", "false", "notAllowed", "unknown" ] }, "example" : "true" }, "networkDevicesFilterParam" : { "name" : "filter[devices]", "in" : "query", "description" : "Filter by IDs of devices on this network. Filter by multiple values by providing a comma delimited list.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTk5NTAyNzg2ODc3MDYzNDI1LDE5OTUwMjc5MTExMzAyODg2Nw" }, "componentIdFilterParam" : { "name" : "filter[componentId]", "in" : "query", "description" : "Filter by component ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDA4ODI4MDE3MzQwZGViYTQ5OA" }, "parentDeviceIdFilterParam" : { "name" : "filter[parentDevice]", "in" : "query", "description" : "Filter by the entity's parent device ID.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "MTkwNzAyOTIzMDk3NzA4MDMzLDMwOTIyNTc3MjQ5ODE5MDgyNA" }, "vendorNameFilterParam" : { "name" : "filter[vendorName]", "in" : "query", "description" : "Filter by the device’s vendor/manufacturer.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Ubiquiti" }, "onlineStatusFilterParam" : { "name" : "filter[onlineStatus]", "in" : "query", "description" : "Filter by the device’s online status.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "online", "offline", "unreachable", "testing", "unknown", "dormant", "notPresent", "lowerLayerDown" ] }, "example" : "online" }, "modifiedAfterFilterParam" : { "name" : "filter[modifiedAfter]", "in" : "query", "description" : "Filter by date and time, only returning entities modified after provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-03-12T12:00:00.000Z" }, "notSeenSinceFilterParam" : { "name" : "filter[notSeenSince]", "in" : "query", "description" : "Filter by the last seen online time, returning entities not seen online after the provided value.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2018-11-30T18:34:42.652Z" }, "stateKnownFilterParam" : { "name" : "filter[stateKnown]", "in" : "query", "description" : "Filter by devices with recently updated data, for more consistent results.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "boolean" } }, "usageFromDateFilterParam" : { "name" : "filter[fromDate]", "in" : "query", "description" : "Date from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-01" }, "usageThruDateFilterParam" : { "name" : "filter[thruDate]", "in" : "query", "description" : "Date to which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "pattern" : "20[0-9]{2}-[01][0-9]-[0123][0-9]", "type" : "string" }, "example" : "2019-06-30" }, "asmClientPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of ASM client", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "asmClientIdFilterParam" : { "name" : "filter[clientId]", "in" : "query", "description" : "Filter by client ID", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "a09a70dc-7070-498d-b7fd-ab37a81185c5" }, "includeAsmClientDetailParam" : { "name" : "include", "in" : "query", "description" : "Use to include extended details of the client.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "totals" ] }, "example" : "totals" }, "asmApplicationPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of ASM application", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "includeAsmApplicationDetailParam" : { "name" : "include", "in" : "query", "description" : "Use to include extended details of the application or of its related objects.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "all", "breaches", "users", "contracts", "publisher", "accessData" ] }, "example" : "users,contracts" }, "asmSecurityLogPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of ASM security log", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "includeAsmSecurityLogDetailParam" : { "name" : "include", "in" : "query", "description" : "Use to include extended details of the security log or of its related objects.", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "users", "applications" ] }, "example" : "users,contracts" }, "asmTagPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of ASM tag", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "asmUserPathIdParam" : { "name" : "id", "in" : "path", "description" : "ID of ASM user", "required" : true, "style" : "simple", "explode" : false, "schema" : { "type" : "string" } }, "pageFirstParam" : { "name" : "page[first]", "in" : "query", "description" : "For paginated responses, the first N elements will be returned. Used in combination with page[after].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, "pageAfterParam" : { "name" : "page[after]", "in" : "query", "description" : "Cursor after which elements will be returned as a page. The page size is provided by page[first].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[first]=100" }, "pageLastParam" : { "name" : "page[last]", "in" : "query", "description" : "For paginated responses, the last N services will be returned. Used in combination with page[before].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "number", "default" : 100.0 }, "example" : "100" }, "pageBeforeParam" : { "name" : "page[before]", "in" : "query", "description" : "Cursor before which elements will be returned as a page. The page size is provided by page[last].", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "Y3Vyc29yOjE5OTc2MjIzNTAxNTE2ODAwNCwxOTk3NjI0ODM4MzI2MTI2MTE&page[last]=100" }, "statFilterFromTimeParam" : { "name" : "filter[fromTime]", "in" : "query", "description" : "Timestamp from which you want to query", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-10T01:00:00.000Z" }, "statFilterThruTimeParam" : { "name" : "filter[thruTime]", "in" : "query", "description" : "Timestamp to which you want to query (defaults to current time)", "required" : false, "style" : "form", "explode" : true, "schema" : { "type" : "string" }, "example" : "2020-03-11T01:00:00.000Z" }, "statFilterIntervalParam" : { "name" : "filter[interval]", "in" : "query", "description" : "Statistics reporting interval", "required" : true, "style" : "form", "explode" : true, "schema" : { "type" : "string", "enum" : [ "minute", "hour", "day" ] }, "example" : "hour" } }, "securitySchemes" : { "ApiKey" : { "type" : "http", "description" : "Username and apiKey as the password", "scheme" : "basic" } } }, "x-tagGroups" : [ { "name" : "inventory", "tags" : [ "Device", "Network", "Interface", "Component", "Entity", "Configuration" ] }, { "name" : "alert", "tags" : [ "Alert History", "Alert" ] }, { "name" : "other", "tags" : [ "Credentials" ] }, { "name" : "client management", "tags" : [ "Tenants" ] }, { "name" : "billing", "tags" : [ "Usage" ] }, { "name" : "statistics", "tags" : [ "Statistics" ] }, { "name" : "Pollers", "tags" : [ "SNMP Poller", "SNMP Poller History" ] }, { "name" : "Auvik SaaS Management", "tags" : [ "ASM" ] } ] }