Actions41
- Alert Actions
- Alert History Actions
- ASM Actions
- Component Actions
- Configuration Actions
- Device Actions
- Device V2 (Beta) Actions
- Entity Actions
- Interface Actions
- Network Actions
- Playbook Actions
- SNMP Poller Actions
- Tenant Actions
- Usage Actions
Device → Get One
AI-generatedSummary
Retrieves a single device record from Auvik by its ID, optionally including related device details like components, configurations, and interfaces.
Inputs
- id (required) — The unique identifier of the device to retrieve.
- includeDeviceDetail — When true, requests the deviceDetail relationship which contains sub-resources such as components, configurations, interfaces, and connected devices.
- fieldsDeviceDetail — A list of specific fields to include from the deviceDetail relationship. This field is only available when includeDeviceDetail is enabled.
Output shape
a single record
If the specified ID does not exist, the operation returns an empty item. The 'fieldsDeviceDetail' parameter selects specific sub-resources from the deviceDetail relationship.
Examples
Example 1: Basic Device Lookup
Set 'id' to a known device ID. The default output is the core device information.
Example 2: Device with Interfaces and Components
Enable 'includeDeviceDetail' and select 'interfaces' and 'components' from the 'fieldsDeviceDetail' options to retrieve network interface data and component inventory.