Inventory Device Name Ipping
Endpoints Summary
GET
/inventory_device_name_ipping/{name}/
Swagger ↗
The inventory device name
pingingipping endpoint providesa wayfunctionality to retrieve device information bydevicename, specifically focused onping-relatedIP ping capabilities and network connectivity statusand connectivity data. This endpoint is commonly usedfornetworkinventorymonitoring,managementdevice health checks, and troubleshooting connectivity issues.systems.
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 pingingipping API allowscategory youis todesigned queryfor specificnetwork devicesadministrators byand theirIT nameteams who need to retrieve ping-relateddevice information based on device names, with a specific focus on IP ping capabilities and network connectivity status.monitoring. This endpoint is particularly useful for inventory management systems that need to verify device connectivity status, perform network administratorsdiagnostics, or retrieve device information for monitoring dashboards.
Common scenarios include automated network health checks, device discovery processes, and integration with monitoring systems that need to checkcorrelate device reachabilitynames with their ping status and connectivity information. The endpoint provides essential device data that can be used to determine if a device is reachable on the network and retrieve its current operational status.
This API is typically used in conjunction with other inventory management endpoints to provide a complete picture of device status and network health.
Keywithin featuresan oforganization's this API category:
This endpoint is commonly integrated into network monitoring solutions, DevOps pipelines, and infrastructure management platforms where real-time device connectivity information is critical for maintaining system reliability.infrastructure.
Endpoints
GET /inventory_device_name_ipping/{name}/
Description: Retrieves device information and ping status and connectivity information for a specific device identified by its name. This endpoint returnsis detailedessential information about the device'sfor network reachability,monitoring responseapplications times, and current ping status. Use this endpoint when youthat need to check ifdevice aconnectivity specificand retrieve basic device isinformation respondingfor toinventory networkmanagement requests or when troubleshooting connectivity issues.purposes.
Use Cases:
MonitorNetwork health monitoring systems checking deviceavailability in network monitoring dashboardsconnectivity- Automated
healthinventorychecksauditsforverifyingcriticaldeviceinfrastructure componentsaccessibility TroubleshootTroubleshooting tools that need to correlate device names with network status
Full URL Example:
https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-web-01/
Parameters:
| Parameter | Type | In | Required | Description |
|---|---|---|---|---|
| name | string | path | Yes | The unique name identifier of the device to |
cURL Example:
curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_ipping/server-web-01/" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-H "Content-Type: application/json"
Example Response:
{
"id": 1247,
"device_name"name": "server-web-01",
"ip_address": "192.168.1.100",
"ping_status": "online"active",
"last_ping_time": "2024-01-15T14:32:15Z"30:25Z",
"response_time_ms": 12.4,12,
"packet_loss_percent": 0.0,
"uptime_percent": 99.8,
"last_offline"device_type": "2024-01-12T03:15:22Z"server",
"ping_count_24h": 1440,
"failed_pings_24h": 3,
"location": "Data Center A - Rack 15"A",
"device_type"status": "server"online",
"monitoring_enabled"uptime_percentage": true99.8
}
Response Codes:
| Status | Description |
|---|---|
| 200 | Success - Returns |
| 401 | Unauthorized - Invalid or missing API token |
| 404 | Not Found - Device with |
Common Use Cases
Use Case 1: Network MonitoringHealth Dashboard
DisplayMonitor real-timethe deviceconnectivity status inof monitoringcritical dashboardsinfrastructure devices by querying specific devices and showing their ping status,status and response times,times. Use this endpoint to populate real-time network health dashboards that display device availability and uptimeperformance percentages. Perfect for NOC (Network Operations Center) displays and infrastructure oversight.metrics.
Use Case 2: Automated HealthNetwork ChecksDiagnostics
Integrate this endpoint intoImplement automated monitoring scripts that check criticaldevice connectivity as part of routine network maintenance. The endpoint can be used to identify devices atthat regularmay intervals.be Setexperiencing upnetwork alerts when devices become unreachableissues or showare degraded performance metrics.unreachable.
Use Case 3: TroubleshootingInventory WorkflowVerification
WhenValidate users report connectivity issues, quickly check specificthat devices bylisted namein your inventory system are actually accessible on the network. This is particularly useful during asset audits or when onboarding new devices to identifyensure proper network problems, packet loss, or response time degradation without needing to access multiple monitoring tools.configuration.
Use Case 4: SLATroubleshooting ReportingIntegration
Generate service level agreement reports by collecting uptime data for specific devices over time, helping demonstrate complianceIntegrate with availabilityhelpdesk commitmentsor ticketing systems to customersautomatically orcheck stakeholders.
Use Case 5: Capacity Planning
Monitor response times anddevice connectivity patternswhen forsupport devicestickets toare identifycreated, providing technicians with immediate network bottlenecksstatus and plan infrastructure upgrades before performance issues impact users.information.
Best Practices
- Implement proper error handling for 404 responses when device names don't exist, as this is common during device lifecycle changes