Skip to main content

Inventory Device Name Ipping

The Inventory Device Name IP Ping endpoint provides functionality to retrieve IP connectivity information for network devices by their name. This endpoint is essential for network monitoring, device status verification, and troubleshooting connectivity issues in managed IT environments.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Device Name IP Ping API category enables network administrators and IT teams to retrieve ping-based connectivity data for devices in their inventory using the device name as an identifier. This endpoint is particularly useful for:

  • Network Health Monitoring: Quickly check if a device is reachable on the network
  • Troubleshooting Workflows: Verify connectivity when investigating device issues
  • Automated Monitoring Systems: Integrate ping status checks into monitoring dashboards
  • Device Status Verification: Confirm network accessibility before performing remote operations

This endpoint returns comprehensive ping statistics including response times, packet loss, and reachability status, making it an essential tool for network operations and device management workflows.

Endpoints

GET /inventory_device_name_ipping/{name}/

Description: Retrieves IP ping connectivity information for a specific device identified by its name. This endpoint performs or returns cached ping test results, providing network reachability data including response times, packet loss statistics, and overall connectivity status.

Use Cases:

  • Monitor network connectivity for critical infrastructure devices
  • Verify device accessibility before attempting remote management operations
  • Integrate ping status into automated monitoring and alerting systems
  • Troubleshoot network connectivity issues for specific devices

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-db-01/

Parameters:

Parameter Type In Required Description
name string path Yes The exact name of the device in the inventory system to retrieve ping information for

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-db-01/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "device": {
    "id": 1247,
    "name": "server-db-01",
    "ip_address": "192.168.1.50",
    "device_type": "server",
    "organization": "IT Infrastructure"
  },
  "ping_results": {
    "is_reachable": true,
    "packets_sent": 4,
    "packets_received": 4,
    "packet_loss_percent": 0,
    "response_times_ms": [2.1, 1.8, 2.3, 1.9],
    "average_response_time_ms": 2.025,
    "min_response_time_ms": 1.8,
    "max_response_time_ms": 2.3,
    "last_tested": "2024-01-15T10:30:45Z",
    "test_duration_ms": 3245
  },
  "network_info": {
    "hostname_resolved": "server-db-01.internal.company.com",
    "gateway_ip": "192.168.1.1",
    "subnet": "192.168.1.0/24"
  },
  "status": "online",
  "metadata": {
    "test_method": "icmp_ping",
    "timeout_ms": 5000,
    "cache_ttl_seconds": 300
  }
}

Response Codes:

Status Description
200 Success - Returns ping connectivity data for the specified device
401 Unauthorized - Invalid or missing API token
404 Not Found - Device with the specified name does not exist
429 Too Many Requests - Rate limit exceeded
500 Internal Server Error - Ping test failed due to system error

Common Use Cases

Use Case 1: Network Health Dashboard

Integrate this endpoint into monitoring dashboards to display real-time connectivity status for critical infrastructure. Poll the endpoint periodically to update device status indicators and alert on connectivity issues.

Use Case 2: Pre-Deployment Verification

Before deploying updates or performing maintenance on remote devices, use this endpoint to verify the device is network-accessible and determine baseline connectivity performance.

Use Case 3: Automated Incident Response

Incorporate into incident response workflows to automatically verify network connectivity when device alerts are triggered, helping differentiate between network issues and device-specific problems.

Use Case 4: Network Performance Baseline

Collect ping statistics over time to establish performance baselines for devices and identify degradation trends in network connectivity.

Best Practices

  • Implement Caching: Respect the cache TTL indicated in the response to avoid unnecessary API calls and reduce load on network infrastructure
  • Handle Network Timeouts: Set appropriate request timeouts as ping tests may take several seconds to complete
  • Rate Limiting Awareness: Avoid excessive polling as ping tests consume network resources; implement reasonable intervals between requests
  • Error Handling: Always check for 404 responses when device names might not exist, and implement retry logic for temporary network failures
  • Batch Operations: For monitoring multiple devices, stagger requests to avoid overwhelming the API and network infrastructure
  • Response Time Monitoring: Use the detailed timing data to identify network performance trends and potential issues before they become critical
Back to top