Skip to main content

Inventory Device Ipping

The Inventory Device IP Ping endpoint allows you to retrieve network connectivity status and ping test results for specific devices in your inventory. This is essential for monitoring device network health, troubleshooting connectivity issues, and maintaining network infrastructure visibility.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Device IP Ping API provides network diagnostics and connectivity monitoring capabilities for devices in your inventory management system. This endpoint is specifically designed to help network administrators and IT teams monitor the network status of managed devices by providing ping test results and connectivity metrics.

Key Capabilities:

  • Retrieve ping test results for specific inventory devices
  • Monitor network connectivity status and response times
  • Access historical ping data for network health analysis
  • Support troubleshooting workflows for network connectivity issues

Common Integration Scenarios:

  • Network monitoring dashboards that display device connectivity status
  • Automated alerting systems that trigger on connectivity failures
  • Network health reports and analytics
  • Troubleshooting workflows for IT support teams

This endpoint works in conjunction with your broader inventory management system, providing the network layer visibility needed to maintain reliable device connectivity across your infrastructure.

Endpoints

GET /inventory_device_ipping/{id}/

Description: Retrieves detailed ping test results and network connectivity information for a specific inventory device. This endpoint returns comprehensive network diagnostics including response times, packet loss statistics, and connection status for the specified device.

Use Cases:

  • Checking the current network connectivity status of a critical server or network device
  • Retrieving ping statistics for network performance analysis and reporting
  • Troubleshooting connectivity issues for devices experiencing network problems
  • Monitoring network health as part of automated infrastructure monitoring

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_ipping/1234/

Parameters:

Parameter Type In Required Description
id integer path Yes Unique identifier of the inventory device ping record to retrieve

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_ipping/1234/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "id": 1234,
  "device_id": 5678,
  "device_name": "web-server-01",
  "ip_address": "192.168.1.100",
  "status": "online",
  "last_ping_time": "2024-01-15T14:30:25Z",
  "response_time_ms": 12.5,
  "packet_loss_percent": 0,
  "ping_count": 4,
  "successful_pings": 4,
  "average_response_time": 11.8,
  "min_response_time": 10.2,
  "max_response_time": 14.1,
  "jitter_ms": 1.2,
  "connectivity_status": "stable",
  "last_successful_ping": "2024-01-15T14:30:25Z",
  "last_failed_ping": null,
  "uptime_percentage": 99.95,
  "monitoring_enabled": true,
  "ping_interval_seconds": 300,
  "timeout_threshold_ms": 5000,
  "created_at": "2024-01-10T09:15:00Z",
  "updated_at": "2024-01-15T14:30:25Z"
}

Response Codes:

Status Description
200 Success - Returns the ping data for the specified device
401 Unauthorized - Invalid or missing API token
403 Forbidden - Insufficient permissions to access this device's ping data
404 Not Found - Device ping record with the specified ID does not exist
500 Internal Server Error - Server encountered an error processing the request

Common Use Cases

Use Case 1: Network Health Dashboard

Integrate this endpoint into monitoring dashboards to display real-time connectivity status for critical infrastructure devices. Retrieve ping data for multiple devices to create comprehensive network health visualizations showing response times, uptime percentages, and connectivity trends.

Use Case 2: Automated Alert Systems

Use this endpoint in monitoring scripts that check device connectivity status and trigger alerts when devices become unreachable or experience degraded network performance. The packet loss and response time data can help determine the severity of network issues.

Use Case 3: Troubleshooting Network Issues

When users report connectivity problems, support teams can use this endpoint to quickly assess the network status of affected devices, review recent ping statistics, and identify patterns that might indicate network infrastructure problems.

Use Case 4: Network Performance Reporting

Generate periodic network performance reports by collecting ping data over time, analyzing trends in response times and uptime percentages, and identifying devices that may need network optimization or hardware replacement.

Use Case 5: Infrastructure Capacity Planning

Monitor network performance metrics across your device inventory to identify potential bottlenecks, plan for network upgrades, and ensure adequate network capacity for business operations.

Best Practices

  • Efficient Polling: Avoid making excessive requests to this endpoint. The ping data is typically updated based on the configured ping interval (usually every 5 minutes), so polling more frequently than this interval provides no additional value.

  • Error Handling: Implement proper error handling for 404 responses, as devices may be removed from inventory or have their ping monitoring disabled. Always check the monitoring_enabled field to confirm active monitoring.

  • Performance Monitoring: Use the response_time_ms, packet_loss_percent, and jitter_ms fields to establish baseline performance metrics and detect anomalies that might indicate network degradation.

  • Status Interpretation: The connectivity_status field provides a high-level summary (stable, degraded, unreachable), while individual ping metrics offer detailed diagnostics. Use both for comprehensive network health assessment.

  • Historical Analysis: Combine last_successful_ping and last_failed_ping timestamps with uptime_percentage to understand device reliability patterns and identify recurring connectivity issues.

  • Security Considerations: This endpoint may expose sensitive network topology information. Ensure proper access controls are in place and only authorized personnel can access network connectivity data for critical infrastructure devices.

Back to top