Inventory Device Serial Ipping
RetrieveTheinventoryInventory Device Serial Lookup API provides a direct way to retrieve specific device informationbyusing serialnumbernumbers as identifiers. This endpoint is essential forIPdeviceprovisioningmanagementandworkflows where you need to quickly access devicemanagement.details, verify device existence, or integrate serial number-based lookups into your applications.
Base URL: https://control.zequenze.com/api/v1
Authentication: All endpoints require a Bearer token:
Authorization: Bearer <your-api-token>
Overview
The Inventory Device Serial Lookup API enables developers to retrieve comprehensive device information using device serial numbers. This is particularly valuable for organizations managing large inventories where serial numbers serve as unique identifiers for tracking, maintenance, and asset management purposes.
This endpoint is commonly used in scenarios such as:
The API returns detailed device information including specifications, status, location, and organizational assignments, making it a crucial component for comprehensive device management solutions.
Endpoints
GET /inventory_device_serial_ipping/{serial_number}/
Description: Retrieves device inventorydetailed information and IP provisioning details forabout a specific device identified byusing its serial number.number as the lookup identifier. This endpoint isprovides commonlycomprehensive useddevice data including hardware specifications, current status, organizational assignment, and location details.
Use Cases:
Full provisioningURL andExample:
https://control.zequenze.com/api/v1/inventory_device_serial_ipping/ABC123XYZ789/
processes.Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| serial_number | string | path | Yes | The unique serial number of the device to |
ExamplecURL Request:Example:
curl -X GET "https://control.zequenze.com/api/v1/inventory_device_serial_ipping/ABC123456789/ABC123XYZ789/" \
-H "Authorization: Bearer your-api-tokenYOUR_API_TOKEN" \
-H "Content-Type: application/json"
Example Response:
{
"id": 1234,1247,
"serial_number": "ABC123456789"ABC123XYZ789",
"device_name"name": "switch-floor-2-rack-a"Dell OptiPlex 7090",
"device_type": "Desktop Computer",
"manufacturer": "Dell Inc.",
"model": "CiscoOptiPlex Catalyst 2960",
"manufacturer": "Cisco",
"ip_address": "192.168.1.100",
"subnet_mask": "255.255.255.0",
"gateway": "192.168.1.1",
"vlan_id": 10,
"mac_address": "00:1A:2B:3C:4D:5E",
"location": "Building A - Floor 2"7090",
"status": "active",
"provisioning_profile"condition": "network_switch_standard"excellent",
"last_seen"organization": {
"id": 42,
"name": "IT Department",
"code": "IT-DEPT"
},
"location": {
"building": "Main Office",
"floor": "3rd Floor",
"room": "Conference Room A"
},
"specifications": {
"processor": "Intel Core i7-11700",
"memory": "16GB DDR4",
"storage": "512GB NVMe SSD",
"operating_system": "Windows 11 Pro"
},
"purchase_info": {
"purchase_date": "2023-08-15",
"warranty_expiry": "2026-08-15",
"cost": 1299.99,
"vendor": "Dell Direct"
},
"assigned_user": {
"id": 156,
"name": "John Smith",
"email": "john.smith@company.com",
"department": "Marketing"
},
"last_updated": "2024-01-15T10:30:00Z"15T14:22:33Z",
"created_at": "2024-01-10T09:2023-08-16T09:15:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
Response Codes:
| Status | Description |
|---|---|
| 200 | |
| 401 | Unauthorized - Invalid or missing |
| 404 | |
Common Use Cases
Use Case 1: Support Ticket Device Verification
When users submit support requests, technicians can quickly verify device specifications and warranty status by entering the device serial number, enabling faster and more accurate support responses.
Use Case 2: Asset Audit and Compliance
During scheduled audits, scanning device serial numbers provides immediate access to purchase dates, warranty information, and assigned users, streamlining compliance reporting and asset verification processes.
Use Case 3: Mobile Device Management Integration
Mobile applications can scan device barcodes to instantly retrieve device information, enabling field technicians to access comprehensive device details without returning to desktop systems.
Use Case 4: Automated Provisioning Workflows
Before deploying software or configurations, automated systems can verify device eligibility by checking specifications, status, and organizational assignments through serial number lookups.
Use Case 5: Maintenance Schedule Planning
Facility management systems can lookup device information to schedule preventive maintenance, track device age, and plan replacement cycles based on warranty expiration dates.
Best Practices
-
Serial Number Format: Ensure serial numbers are provided exactly as stored in the
inventorysystem,systemincluding(case-sensitive)proper case sensitivity and any special characters or spacing. -
Caching: Device information is typically cached for 5 minutes to improve performance
Error Handling: AlwaysImplement checkproper error handling for 404 responses when lookingserial upnumbers devicesdon't thatexist, mayand notprovide existmeaningful infeedback inventoryto users about invalid or not-found devices.
Caching Strategy: Cache frequently accessed device information locally to reduce API calls, but implement appropriate cache invalidation to ensure data freshness for critical operations.
Security Considerations: Validate that users have appropriate permissions to view device information before making API calls, and avoid exposing sensitive device details in client-side applications.
Rate Limiting: ThisWhen endpointperforming supportsbulk upserial number lookups, implement appropriate delays between requests to 100avoid requestsoverwhelming perthe minuteAPI, perespecially APIduring keylarge-scale audit operations.
NetworkData TimeoutsValidation: SetAlways appropriatevalidate timeoutsthe (recommended:response 30data seconds)structure before processing, as device lookupsinformation may involvevary networkbased discoveryon device type, organizational policies, and data completeness.