Inventory Device Name Operation

Endpoints Summary

Method Path Swagger PUT /inventory_device_name_operation/{name}/ Swagger ↗

---

ThisThe Inventory Device Name Operation API category enables remote device management operations foron inventoryspecific devices withinin theyour Zequenzeinventory. platform.This Itendpoint providesallows endpointsyou to performexecute critical device operations likesuch reboots,as rebooting, factory resets, configuration synchronization,sync, and device reconfiguration tasksby programmatically. This is essential for IT administrators managing large fleets oftargeting devices whousing needtheir tounique execute maintenance operations remotely without physical access.names.

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 operationOperation API allowsprovides administratorsa topowerful remotelyinterface executefor criticalperforming maintenanceremote and configurationmanagement operations on manageddevices devices.within your inventory system. This API is particularlyspecifically valuabledesigned for:for network administrators, IT operations teams, and automated systems that need to execute device management commands remotely.

Key capabilities include:

• Remote Device ManagementControl: Execute operations on devices across multiple locations without physical access
• Bulk Maintenance Operations: Programmatically perform maintenance tasks across device fleets

Automated Device RecoveryManagement: Integrate device recovery operations into monitoringyour andautomation alerting systemsworkflows ConfigurationCentralized ManagementOperations: SynchronizeManage multiple device configurationsoperations andfrom pusha updatessingle remotelyAPI interface Real-time Execution: Operations are executed immediately upon API call

This endpoint is particularly valuable in scenarios such as troubleshooting network issues, performing scheduled maintenance, deploying configuration changes, or recovering devices that have become unresponsive. The API supports fivevarious coreoperation operations:types reboot,including standard reboots, factory reset, device-specific factory reset,resets, configuration synchronization, and complete device reconfiguration.

Each

The operationoperations isare executed asynchronously, allowing foryour safeapplications managementto ofcontinue devicesprocessing thatwhile maydevice temporarilyoperations losecomplete connectivity duringin the operation.

background.

ImportantThis Concepts:

makes

it Operations are identified by device name rather than IDideal for easierintegration integrationwith Allmonitoring operationssystems, areticketing asynchronousplatforms, and mayautomated takeincident timeresponse to complete Device connectivity may be temporarily interrupted during certain operations Operation status should be monitored through other inventory endpoints workflows.

---

Endpoints

PUT /inventory_device_name_operation/{name}/

Description: Executes a specified operation on a device identified by its name. This endpoint isallows theyou primaryto mechanismperform for remotely managingcritical device states,management performingtasks maintenanceremotely, tasks,including reboots, factory resets, configuration sync, and updatingreconfiguration configurations.operations. The operation is queued and executed asynchronouslyimmediately onupon thesuccessful targetAPI device.call.

Use Cases:

• Remotely reboot unresponsive network devices toduring restore functionalitytroubleshooting
• Perform factory resets on devices being reassigned orto decommissioneddifferent locations
• Synchronize device configurations after policy updates
• ReconfigureExecute device reconfiguration as part of automated deployment workflows

Recover devices withthat newhave networklost connectivity or securityare settingsin Executean maintenanceerror operations during scheduled maintenance windowsstate

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_name_operation/office-printer-router-01/

Parameters:

Parameter	Type	In	Required	Description
name	string	path	Yes	The unique name name/identifier of the target device into perform the inventoryoperation on
data	string	body	Yes	JSON payload containing the operation details and parameters

Request Body Schema:

Field	Type	Required	Description	Allowed Values
operation	string	Yes	The operation to perform on the device	reboot, factory, device_factory, sync, reconf

Operation Types:

• reboot: Performs a standardStandard device restartreboot - restarts the device while preserving configuration
• factory: ExecutesFactory areset complete- returns device to original factory reset, removing all configurations and datasettings
• device_factory: Performs a device-specificDevice factory reset (preserves- certaincomplete reset including device-levelspecific settings)settings
• sync: SynchronizesDevice deviceconfig sync - synchronizes current configuration with thecentral management server
• reconf: ReconfiguresDevice devicereconfigure with- updatedapplies new configuration settings andto policiesthe device

cURL Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_name_operation/office-printer-router-01/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "operation": "reboot"
  }'

Example Request Bodies:

(Reboot Operation:Operation):

{
  "operation": "reboot"
}

FactoryExample ResetRequest Operation:

{
  "operation": "factory"
}

(Configuration Sync Operation:Sync):

{
  "operation": "sync"
}

Example Response:

{
  "id": 1247,12345,
  "operation": "reboot",
  "device_name": "office-router-01",
  "status": "initiated",
  "timestamp": "2024-01-15T14:30:25Z",
  "execution_id": "op_67890abcdef",
  "estimated_completion": "2024-01-15T14:32:25Z"
}

Response Codes:

Status	Description
200	Success - Operation queuedinitiated successfully and will be executed on the device
400	Bad Request - Invalid operation type or malformed request data
401	Unauthorized - Invalid or missing APIauthentication token
404	Not Found - Device with specified name does not exist in inventory
422409	Unprocessable EntityConflict - Device existsis butcurrently cannotoffline performor the requestedanother operation (e.g.,is devicein offline)progress
500	Internal Server Error - ServerFailed errorto occurredinitiate while processing the requestoperation

---

Common Use Cases

Use Case 1: Automated DeviceIncident RecoveryResponse

When monitoring systems detect unresponsivedevice devices,connectivity issues, automatically trigger a reboot operation tousing restorethe functionalityreboot operation type. This can resolve many common network issues without manual intervention.

Example Workflow:

Monitoring system detects device is unresponsive Call the operation endpoint with "operation": "reboot" Monitor device status through inventory endpoints to confirm recovery

Use Case 2: Bulk DeviceScheduled Maintenance Operations

ScheduleIntegrate with scheduling systems to perform configuration sync operations (sync) during maintenance operationswindows, acrossensuring multipleall devices during off-hours by iterating through device names and executing operations.

Example Workflow:

Retrieve list of devices requiring maintenance For each device, callhave the operationlatest endpointapproved with appropriate operation Log operation results for maintenance records configurations.

Use Case 3: Device LifecycleDeployment ManagementPipeline

WhenUse the reconf operation as part of automated device deployment workflows when devices are being reassigned or decommissioned, perform factory resetsneed to ensurebe data security and prepare devicesreconfigured for new deployment.roles or locations.

Example Workflow:

Identify devices for reassignment Execute factory operation to completely reset devices Verify reset completion before physical device transfer

Use Case 4: ConfigurationSecurity DeploymentIncident Recovery

AfterExecute updating device policiesfactory or configurationsdevice_factory inoperations theon management system, synchronize all affectedcompromised devices to applyensure complete removal of potentially malicious configurations or software.

Use Case 5: Configuration Drift Remediation

Regularly use the changes.

Example Workflow:

Update device policies in management system Execute sync operation onto affecteddetect devicesand Monitorcorrect configuration statusdrift toacross ensureyour successfuldevice deploymentinventory, maintaining compliance with organizational standards.

---

Best Practices

Operation Planning:

• Always Operationverify Timing:device Scheduleconnectivity intensivebefore initiating operations that may temporarily disconnect the device

Use sync operations before more disruptive operations like reboot to ensure configurations are current Schedule factory resetsreset operations during maintenance windows to minimize businessservice impact Error Handling: Always check response status codes and implement retry logic for transient failures (500 errors) Device State Monitoring: After executing operations, monitor device status through inventory endpoints to confirm successful completion Batch Processing: When performing operations on multiple devices, implement delays between requests to avoid overwhelming the system Operation Logging: Maintain logs of all operations performed for audit trails and troubleshooting purposes Network Considerations: Be aware that factory resets and reconfigurations may change device network settings, potentially affecting connectivity Security: Ensure API tokens have appropriate permissions for device operations and rotate tokens regularly Timeout Handling: Operations may take several minutes to complete; implement appropriate timeout values in your applicationsdisruption

---

Error Handling and Troubleshooting

Common Issues:

Device Not Found (404)Handling:

• VerifyImplement theretry devicelogic namewith isexponential correctbackoff andfor matchestemporary thefailures inventory(5xx exactlyerrors)
• CheckMonitor thatoperation thecompletion devicethrough existsseparate instatus yourchecking organization's inventorymechanisms
• EnsureHandle proper409 URLconflicts encodingby waiting for devicecurrent namesoperations withto specialcomplete charactersbefore retrying

OperationSecurity Failed (422)Considerations:

• DeviceRestrict mayAPI beaccess offlineto orauthorized unreachablepersonnel and systems only
• SomeLog all device operations mayfor notaudit beand supportedcompliance onpurposes

specificUse factory reset operations judiciously as they require complete device types Device may be in a state that prevents the requested operationreconfiguration

AuthenticationPerformance Issues (401)Optimization:

• VerifyBatch APIsimilar tokenoperations isduring validmaintenance windows to reduce overall impact

Allow adequate time between operations on the same device to prevent conflicts Monitor device response times and notadjust expiredoperation Ensurescheduling token has sufficient permissions for device operations Check that the Authorization header is properly formattedaccordingly

Monitoring Integration:

Integrate operation results with your monitoring and alerting systems Track operation success rates to identify problematic devices or operation types Use operation logs for troubleshooting and capacity planning