Skip to main content

Inventory Device Ipping

Endpoints Summary

Method Path Swagger GET /inventory_device_ipping/{id}/ Swagger ↗

The Inventory Device IP Ping endpointAPI allowsprovides youfunctionality to retrieve network connectivity status and ping test resultsinformation for specificnetwork devices in your inventory. This isendpoint essentialallows foryou monitoringto monitor network connectivity and troubleshoot device networkaccessibility health,issues troubleshootingacross connectivityyour issues, and maintaining network infrastructure visibility.infrastructure.

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 providescategory enables you to access ping test results and network diagnostics and connectivity monitoring capabilitiesdata for devices in your inventory management system. This endpointAPI is specificallyessential designed to helpfor network administratorsmonitoring, device health checks, and IT teams monitor the network status of managed devices by providing ping test results andtroubleshooting connectivity metrics.issues.

Key Capabilities:capabilities include:

  • RetrieveRetrieving ping test results for specific inventory devices
  • MonitorMonitoring network connectivitydevice status and response timesaccessibility
  • AccessAccessing historical pingconnectivity data for network health analysis
  • SupportSupporting network 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 worksis incommonly conjunctionused with your broader inventory management system, providing theby network layeradministrators, visibilitymonitoring neededsystems, and automated scripts that need to maintain reliableverify device connectivity acrossstatus. yourThe infrastructure.ping data helps identify network issues, validate device configurations, and ensure infrastructure reliability.

    The API follows RESTful conventions and returns detailed ping information including response times, packet loss statistics, and connection status indicators.

    Endpoints

    GET /inventory_device_ipping/{id}/

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

    Use Cases:

    • CheckingMonitor thenetwork currentdevice health and connectivity status
    Troubleshoot network connectivity statusissues offor aspecific critical server or network devicedevices RetrievingRetrieve ping statistics for network performance analysis and reporting TroubleshootingValidate connectivitydevice issuesaccessibility forbefore devicesperforming experiencingmaintenance network problems Monitoring network health as part of automated infrastructure monitoringoperations

    Full URL Example:

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

    Parameters:

    Parameter Type In Required Description
    id integer path Yes UniqueThe 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/123/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

    Example Response:

    {
  "id": 1234,123,
  "device_id": 5678,456,
  "device_name": "web-server-Core Switch 01",
  "ip_address": "192.168.1.100"10",
  "status": "online",
  "last_ping_time": "2024-01-15T14:15T10:30:25Z"00Z",
  "response_time_ms": 12.5,2.45,
  "packet_loss_percent": 0.0,
  "ping_count": 4,
  "successful_pings": 4,
  "average_response_time": 11.8,2.38,
  "min_response_time": 10.2,2.12,
  "max_response_time": 14.1,2.67,
  "jitter_ms"is_reachable": 1.2,
  "connectivity_status": "stable",true,
  "last_successful_ping": "2024-01-15T14:15T10:30:25Z"00Z",
  "last_failed_ping": null,
  "consecutive_failures": 0,
  "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"95
}

    Response Codes:

    Status Description
    200 Success - Returns the ping data for the specified device
    401 Unauthorized - Invalid or missing API token
    404
    Not Found - Device ping record with specified ID does not exist 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 requestdevice

    Common Use Cases

    Use Case 1: Network Health DashboardMonitoring

    IntegrateMonitor this endpoint into monitoring dashboards to display real-timethe connectivity status forof critical network infrastructure devices.devices Retrieveby regularly checking their ping datastatistics. forThis multiplehelps identify devices tothat createmay comprehensivebe networkexperiencing health visualizations showing response times, uptime percentages, andintermittent connectivity trends.issues or degraded performance.

    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, supportretrieve teamsping candata usefor thisaffected endpointdevices to quickly assessidentify whether the issue is related to network connectivity, high latency, or packet loss.

    Use Case 3: Maintenance Planning

    Before performing maintenance on network devices, check their current ping status ofto affectedensure devices,they revieware recent ping statistics,accessible and identifyfunctioning patternsproperly. thatThis mighthelps indicateavoid networkscheduling infrastructuremaintenance problems.during existing outages.

    Use Case 4: Network Performance ReportingAnalysis

    Generate periodic network performance reports by collectingAnalyze ping data over time, analyzing trends in response times and uptimepacket percentages,loss statistics over time to identify trends in network performance and identifyingplan devicesinfrastructure that may need network optimization or hardware replacement.improvements.

    Use Case 5: InfrastructureAutomated Capacity PlanningAlerting

    MonitorIntegrate networkping performancedata metricsinto acrossmonitoring your device inventorysystems to identifytrigger potentialalerts bottlenecks,when plandevices forbecome networkunreachable upgrades,or andwhen ensureresponse adequatetimes networkexceed capacityacceptable for business operations.thresholds.

    Best Practices

    • EfficientRegular Polling:Monitoring: AvoidPoll makingdevice ping status at appropriate intervals based on your monitoring requirements, but avoid excessive requests tothat thiscould endpoint.impact Thenetwork 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.

      performance

    • Error Handling:Handling: Implement proper error handling for 404cases responses, aswhere devices may be removedtemporarily from inventoryunreachable or have their ping monitoringrecords disabled.may Alwaysnot check the monitoring_enabled field to confirm active monitoring.

      exist

    • PerformanceThreshold Monitoring:Management: UseEstablish thereasonable response_time_ms,thresholds packet_loss_percent,for response times and jitter_mspacket fieldsloss topercentages establishbased baselineon performanceyour metricsnetwork requirements and detect anomalies that might indicate network degradation.

      SLAs

    • StatusHistorical Interpretation:Tracking: The connectivity_status field provides a high-level summary (stable, degraded, unreachable), while individualStore ping metricsdata offerover detailed diagnostics. Use both for comprehensive network health assessment.

    Historical Analysis: Combine last_successful_ping and last_failed_ping timestamps with uptime_percentagetime to understand device reliabilityidentify patterns and identifytrends recurringin connectivitynetwork issues.

    performance

    Security Considerations:Considerations: ThisEnsure endpointAPI maytokens exposeare sensitiveproperly secured and rotated regularly, and limit access to ping data based on user permissions

    Rate Limiting: Be mindful of API rate limits when implementing automated monitoring solutions Correlation with Events: Correlate ping failures with other network topologyevents information.or Ensuremaintenance properactivities accessto controlsbetter are in place and only authorized personnel can access networkunderstand connectivity data for critical infrastructure devices. issues
    Back to top