Skip to main content

Inventory Device Serial Ipping

Retrieve inventory device information by serial number for IP provisioning and device management.

Base URL: https://control.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Endpoints

GET /inventory_device_serial_ipping/{serial_number}/

Retrieves device inventory information and IP provisioning details for a specific device identified by its serial number. This endpoint is commonly used for device lookup during network provisioning and configuration processes.

Parameters:

Parameter Type In Required Description
serial_number string path Yes The unique serial number of the device to retrieve

Example Request:

GET /api/v1/inventory_device_serial_ipping/ABC123456789/
Authorization: Bearer your-api-token

Example Response:

{
  "id": 1234,
  "serial_number": "ABC123456789",
  "device_name": "switch-floor-2-rack-a",
  "model": "Cisco 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",
  "status": "active",
  "provisioning_profile": "network_switch_standard",
  "last_seen": "2024-01-15T10:30:00Z",
  "created_at": "2024-01-10T09:15:00Z",
  "updated_at": "2024-01-15T10:30:00Z"
}
Status Description
200 Device found and returned successfully
401 Unauthorized - Invalid or missing API token
404 Device with specified serial number not found
500 Internal server error

Best Practices

  • Serial Number Format: Ensure serial numbers are provided exactly as stored in the inventory system (case-sensitive)
  • Caching: Device information is typically cached for 5 minutes to improve performance
  • Error Handling: Always check for 404 responses when looking up devices that may not exist in inventory
  • Rate Limiting: This endpoint supports up to 100 requests per minute per API key
  • Network Timeouts: Set appropriate timeouts (recommended: 30 seconds) as device lookups may involve network discovery
Back to top