Inventory Device Name Ipping
Retrieve device naming and IP ping configuration information from the inventory system.
Base URL: https://control.zequenze.com/api/v1
Authentication: All endpoints require a Bearer token:
Authorization: Bearer <your-api-token>
Endpoints
GET /inventory_device_name_ipping/{name}/
Retrieves device naming and IP ping configuration details for a specific device by its name identifier.
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| name | string | path | Yes | The unique name identifier of the device |
Example Request:
GET /api/v1/inventory_device_name_ipping/server-001/
Authorization: Bearer your-api-token
Example Response:
{
"name": "server-001",
"display_name": "Production Server 001",
"ip_address": "192.168.1.100",
"ping_enabled": true,
"ping_interval": 30,
"ping_timeout": 5,
"last_ping_status": "success",
"last_ping_time": "2024-01-15T10:30:00Z",
"response_time_ms": 12.5,
"device_type": "server",
"location": "datacenter-a",
"created_at": "2024-01-01T08:00:00Z",
"updated_at": "2024-01-15T10:30:00Z"
}
Response Codes:
| Status | Description |
|---|---|
| 200 | Device information retrieved successfully |
| 401 | Unauthorized - Invalid or missing API token |
| 404 | Device not found with the specified name |
| 500 | Internal server error |
Best Practices
- Use the exact device name as it appears in your inventory system
- Device names are case-sensitive - ensure proper capitalization
- Monitor the
last_ping_statusfield to track device connectivity - Consider the
ping_intervalwhen implementing monitoring workflows - Cache responses appropriately as device configurations don't change frequently
- Handle 404 responses gracefully when devices may have been removed from inventory