Inventory Device Name Ipping

RetrieveThe 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 namingstatus verification, and IPtroubleshooting pingconnectivity configurationissues informationin frommanaged theIT inventory system.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 device naming and IP ping configurationconnectivity detailsinformation for a specific device identified by its namename. identifier.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 uniqueexact name identifier of the device in the inventory system to retrieve ping information for

ExamplecURL Request:Example:

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

Example Response:

{
  "device": {
    "id": 1247,
    "name": "server-001",
  "display_name": "Production Server 001"db-01",
    "ip_address": "192.168.1.100"50",
  "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"organization": "datacenter-a"IT Infrastructure"
  },
  "created_at"ping_results": {
    "2024-01-01T08:00:00Z"is_reachable": true,
    "packets_sent": 4,
    "packets_received": 4,
    "packet_loss_percent": 0,
    "response_times_ms": [2.1, 1.8, 2.3, 1.9],
    "updated_at"average_response_time_ms": 2.025,
    "min_response_time_ms": 1.8,
    "max_response_time_ms": 2.3,
    "last_tested": "2024-01-15T10:30:00Z"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	DeviceSuccess information- retrievedReturns successfullyping connectivity data for the specified device
401	Unauthorized - Invalid or missing API token
404	Not Found - Device not found with the specified name does not exist

429 Too Many Requests - Rate limit exceeded 500 Internal serverServer 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

• Use Implement Caching: Respect the exactcache deviceTTL nameindicated in the response to avoid unnecessary API calls and reduce load on network infrastructure

Handle Network Timeouts: Set appropriate request timeouts as itping appearstests inmay yourtake inventoryseveral systemseconds to complete Device namesRate areLimiting case-sensitiveAwareness: -Avoid ensureexcessive properpolling capitalizationas ping tests consume network resources; implement reasonable intervals between requests Monitor theError last_ping_statusHandling: fieldAlways tocheck track device connectivity Consider the ping_interval when implementing monitoring workflows Cache responses appropriately as device configurations don't change frequently Handlefor 404 responses gracefully when devicesdevice maynames havemight beennot removedexist, fromand inventoryimplement 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

---