Inventory Device Name Ipping
The
InventoryinventoryDevicedeviceNamenameIP Pingpinging endpoint providesfunctionalitya way to retrieveIPdevice information by device name, specifically focused on ping-related status and connectivityinformation for network devices by their name.data. This endpoint isessentialcommonly used for network monitoring, devicestatushealthverification,checks, and troubleshooting connectivityissues in managed IT environments.issues.
Base URL: https://control.zequenze.com/api/v1
Authentication: All endpoints require a Bearer token:
Authorization: Bearer <your-api-token>
Overview
The Inventoryinventory Devicedevice Namename IP Pingpinging API categoryallows enablesyou networkto administratorsquery andspecific ITdevices teamsby their name to retrieve ping-basedrelated information and connectivity data for devices in their inventory using the device name as an identifier.status. This endpoint is particularly useful for:for network administrators and monitoring systems that need to check device reachability and network health.
Key features of this API category:
-
NetworkDevice-specificHealth Monitoringqueries:QuicklyRetrievecheckinformationifaboutaindividualdevicedevicesisusingreachabletheironuniquethe networknames -
TroubleshootingPingWorkflowsstatus monitoring:VerifyGet current connectivitywhenandinvestigatingpingdeviceresponseissuesdata -
AutomatedNetworkMonitoring Systemstroubleshooting:IntegrateIdentifypingconnectivitystatusissueschecksandintonetworkmonitoring dashboardsbottlenecks -
Device Status VerificationIntegration-friendly:ConfirmPerfect for monitoring dashboards, alerting systems, and automated networkaccessibilitymanagementbefore performing remote operationstools
This endpoint returnsis comprehensivecommonly pingintegrated statisticsinto includingnetwork responsemonitoring times,solutions, packetDevOps loss,pipelines, and reachabilityinfrastructure status,management makingplatforms itwhere anreal-time essentialdevice toolconnectivity information is critical for networkmaintaining operationssystem and device management workflows.reliability.
Endpoints
GET /inventory_device_name_ipping/{name}/
Description: Retrieves IPping pingstatus and connectivity information for a specific device identified by its name. This endpoint performs or returns cacheddetailed pinginformation testabout results,the providingdevice's network reachability data includingreachability, response times, packet loss statistics, and overallcurrent ping status. Use this endpoint when you need to check if a specific device is responding to network requests or when troubleshooting connectivity status.issues.
Use Cases:
- Monitor device availability in network
connectivitymonitoring dashboards
Full URL Example:
https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-db-web-01/
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| name | string | path | Yes | The |
cURL Example:
curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-db-web-01/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Example Response:
{
"device": {
"id": 1247,
"name"device_name": "server-db-web-01",
"ip_address": "192.168.1.50"100",
"ping_status": "online",
"last_ping_time": "2024-01-15T14:32:15Z",
"response_time_ms": 12.4,
"packet_loss_percent": 0.0,
"uptime_percent": 99.8,
"last_offline": "2024-01-12T03:15:22Z",
"ping_count_24h": 1440,
"failed_pings_24h": 3,
"location": "Data Center A - Rack 15",
"device_type": "server",
"organization"monitoring_enabled": "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
}true
}
Response Codes:
| Status | Description |
|---|---|
| 200 | Success - Returns the ping |
| 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 - |
Common Use Cases
Use Case 1: Network Monitoring Dashboard
Display real-time device status in monitoring dashboards by querying specific devices and showing their ping status, response times, and uptime percentages. Perfect for NOC (Network Operations Center) displays and infrastructure oversight.
Use Case 2: Automated Health DashboardChecks
Integrate this endpoint into automated monitoring dashboardsscripts tothat display real-time connectivity status forcheck critical infrastructure.devices Pollat theregular endpointintervals. periodicallySet toup updatealerts devicewhen statusdevices indicatorsbecome and alert on connectivity issues.
Use Case 2: Pre-Deployment Verification
Before deploying updatesunreachable or performingshow maintenancedegraded onperformance remote devices, use this endpoint to verify the device is network-accessible and determine baseline connectivity performance.metrics.
Use Case 3: AutomatedTroubleshooting Incident ResponseWorkflow
IncorporateWhen intousers incidentreport connectivity issues, quickly check specific devices by name to identify network problems, packet loss, or response workflowstime degradation without needing to automaticallyaccess verifymultiple networkmonitoring connectivity when device alerts are triggered, helping differentiate between network issues and device-specific problems.tools.
Use Case 4: NetworkSLA Performance BaselineReporting
CollectGenerate pingservice statisticslevel agreement reports by collecting uptime data for specific devices over timetime, helping demonstrate compliance with availability commitments to establishcustomers performanceor baselinesstakeholders.
Use Case 5: Capacity Planning
Monitor response times and connectivity patterns for devices andto identify degradation trends in network connectivity.bottlenecks and plan infrastructure upgrades before performance issues impact users.
Best Practices
-
ImplementUseCachingmeaningful device names:RespectEnsurethedevicecachenamesTTLfollowindicatedainconsistentthenamingresponseconvention that makes them easily identifiable and searchable