Inventory Device Ipping

The inventoryInventory deviceDevice IP ping APIPing endpoint providesallows functionalityyou to retrieve IPnetwork connectivity status and ping informationtest results for specific devices in your inventory. This endpointis allowsessential youfor tomonitoring monitordevice network health, troubleshooting connectivity statusissues, and track ping metrics for managed devices, helping withmaintaining network diagnosticsinfrastructure and device health monitoring.visibility.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The inventoryInventory deviceDevice IP pingPing API provides network diagnostics and connectivity monitoring capabilities for devices in your inventory management system. This endpoint is specifically designed forto help network administrators and IT teams whomonitor needthe tonetwork monitorstatus of managed devices by providing ping test results and trackconnectivity themetrics.

Key Capabilities:

Retrieve ping test results for specific inventory devices Monitor network connectivity status ofand devicesresponse intimes theirAccess managed inventory. This endpoint provides detailedhistorical ping informationdata includingfor responsenetwork times,health packetanalysis lossSupport statistics,troubleshooting andworkflows for network connectivity statusissues for specific devices.

Common useIntegration cases include:Scenarios:

• MonitoringNetwork networkmonitoring dashboards that display device connectivity status

Automated alerting systems that trigger on connectivity failures Network health acrossreports yourand device inventoryanalytics Troubleshooting connectivity issuesworkflows for specificIT devicessupport Generating network performance reports Setting up automated network monitoring workflows Tracking historical ping performance datateams

This endpoint works asin partconjunction ofwith theyour broader inventory management system, allowingproviding youthe network layer visibility needed to correlatemaintain reliable device informationconnectivity withacross networkyour performance metrics. The ping data can be used to identify network bottlenecks, plan maintenance windows, and ensure optimal device connectivity.infrastructure.

---

Endpoints

GET /inventory_device_ipping/{id}/

Description: Retrieves detailed IPping pingtest results and network connectivity information for a specific deviceinventory in your inventory.device. This endpoint returns comprehensive connectivitynetwork metricsdiagnostics including ping response times, packet loss statistics, success rates, and historicalconnection ping datastatus for the specified device.

Use Cases:

• MonitorChecking real-timethe current network connectivity forstatus of a critical infrastructureserver devicesor network device
• TroubleshootRetrieving ping statistics for network performance analysis and reporting

Troubleshooting connectivity issues byfor reviewingdevices pingexperiencing historynetwork and statisticsproblems GenerateMonitoring network performancehealth reportsas forpart specificof devicesautomated Validateinfrastructure network changes and improvements over timemonitoring

Full URL Example:

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

Parameters:

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

cURL Example:

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

Example Response:

{
  "id": 12345,1234,
  "device_id": 67890,5678,
  "device_name": "Server-NYC-001"web-server-01",
  "ip_address": "192.168.1.100",
  "ping_status"status": "active"online",
  "last_ping_time": "2024-01-15T14:32:15Z"30:25Z",
  "response_time_ms": 12.5,
  "packet_loss_percentage"packet_loss_percent": 0.0,
  "success_rate_24h"ping_count": 99.4,
  "successful_pings": 4,
  "average_response_time": 11.8,
  "total_pings_24h"min_response_time": 1440,
  "failed_pings_24h": 3,
  "average_response_time_24h": 11.10.2,
  "min_response_time_24h"max_response_time": 8.14.1,
  "max_response_time_24h"jitter_ms": 45.7,1.2,
  "ping_enabled"connectivity_status": true,
  "ping_interval_seconds": 60,
  "timeout_seconds": 5,stable",
  "last_successful_ping": "2024-01-15T14:32:15Z"30:25Z",
  "last_failed_ping": null,
  "2024-01-15T08:15:30Z",uptime_percentage": 99.95,
  "monitoring_enabled": true,
  "ping_interval_seconds": 300,
  "timeout_threshold_ms": 5000,
  "created_at": "2024-01-10T09:00:15:00Z",
  "updated_at": "2024-01-15T14:32:15Z",
  "historical_data": [
    {
      "timestamp": "2024-01-15T14:30:00Z",
      "response_time_ms": 11.8,
      "status": "success"
    },
    {
      "timestamp": "2024-01-15T14:29:00Z",
      "response_time_ms": 12.1,
      "status": "success"
    }
  ]25Z"
}

Response Codes:

Status	Description
200	Success - Returns the ping informationdata for the specified device
401	Unauthorized - Invalid or missing authenticationAPI token

404 Not Found - Device with specified ID does not exist or ping monitoring not configured 403 Forbidden - Insufficient permissions to access devicethis device's ping informationdata 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 metricsdata for multiple devices to buildcreate a real-timecomprehensive network health monitoringvisualizations dashboard.showing Useresponse thistimes, endpointuptime topercentages, gatherand connectivity status and response times for all critical infrastructure devices.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 ConnectivityNetwork Issues

When users report connectivity problems, fetchsupport detailedteams can use this endpoint to quickly assess the network status of affected devices, review recent ping historystatistics, for the affected device toand identify patterns, intermittent failures, or degraded performancepatterns that might indicate network issues.

infrastructure

Use Case 3: Performance Baseline Establishment

Collect historical ping data to establish performance baselines for network segments, helping to identify when response times deviate from normal patterns and require investigation.problems.

Use Case 4: MaintenanceNetwork WindowPerformance 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

ReviewMonitor pingnetwork successperformance ratesmetrics andacross failureyour patternsdevice inventory to identify optimalpotential maintenancebottlenecks, windowsplan whenfor devicesnetwork experienceupgrades, theand leastensure connectivityadequate issuesnetwork orcapacity lowestfor usagebusiness periods.operations.

---

Best Practices

• PollingEfficient FrequencyPolling:: Avoid making excessive APIrequests callsto bythis implementingendpoint. appropriateThe cachingping strategies.data Consideris typically updated based on the configured ping interval configured(usually forevery devices5 whenminutes), determiningso howpolling more frequently tothan fetchthis updatedinterval data.provides no additional value.

• Error HandlingHandling:: Implement robustproper error handling for 404 responses, as devices may be temporarilyremoved unavailablefrom inventory or have their ping monitoring mightdisabled. beAlways disabledcheck forthe certainmonitoring_enabled devices.field to confirm active monitoring.

• DataPerformance InterpretationMonitoring:: Use the 24-hourresponse_time_ms, statisticspacket_loss_percent, (success_rate_24h,and average_response_time_24h)jitter_ms forfields trendto analysisestablish ratherbaseline thanperformance relyingmetrics solelyand ondetect theanomalies mostthat recentmight pingindicate result,network which may not be representative.degradation.

• MonitoringStatus ThresholdsInterpretation:: EstablishThe appropriateconnectivity_status thresholdsfield provides a high-level summary (stable, degraded, unreachable), while individual ping metrics offer detailed diagnostics. Use both for response times and success rates based on yourcomprehensive network infrastructurehealth and business requirements rather than using fixed values.assessment.

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

Security Considerations:: LeverageThis theendpoint historical_datamay arrayexpose sensitive network topology information. Ensure proper access controls are in place and only authorized personnel can access network connectivity data for trendcritical analysisinfrastructure and pattern recognition, but be aware that the amount of historical data returned may be limited to prevent large response sizes.devices.