Inventory Device Serial Operation

Endpoints Summary

Method Path Swagger PUT /inventory_device_serial_operation/{serial_number}/ Swagger ↗

---

The Inventory Device Serial Operation endpoints enable remoteinventory device managementserial byoperation allowingendpoint allows you to perform criticalremote management operations on specific devices identifiedin byyour inventory using their serial numbers. This API providesenables a streamlined way to execute commoncritical device maintenancemanagement tasks suchlike as reboots,rebooting, factory resets, configuration synchronization,syncing, and device reconfiguration withoutthrough physicala accesssimple toREST the devices.interface.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventoryinventory Devicedevice Serialserial Operationoperation API categoryprovides providesa powerful interface for remote device management capabilities for remotely controlling devices inwithin your organization's inventory system. This APIendpoint isallows essential for IT administrators, device managers,administrators and automated systems thatto execute critical operations on devices without requiring physical access or manual intervention.

The primary purpose of this API is to enable centralized device lifecycle management, allowing you to:

Remotely reboot devices experiencing issues Perform factory resets when devices need to performbe maintenancerepurposed operationsor onare deployed devices across different locations.

Key Features:

malfunctioning Execute devicedevice-specific operationsfactory usingresets serialthat numberspreserve ascertain unique identifiersconfigurations Support for multiple operation types including reboots, factory resets, and configuration management Designed for both manual administrative tasks and automated device lifecycle management Real-time operation execution with immediate response feedback

Common Scenarios:

Remote Troubleshooting: Restart unresponsive devices without physical access Device Provisioning: Factory reset devices for redeployment or initial setup Configuration Management: SyncSynchronize device configurations orto triggerensure reconfigurationconsistency afteracross policyyour changesfleet Reconfigure Maintenancedevices Workflows:with Integrateupdated devicesettings operationsor into automated maintenance schedulesparameters

This API categoryendpoint is particularly valuable forin organizationsscenarios managingwhere largedevices fleetsare deployed in remote locations, managed at scale, or when quick remediation is needed to maintain operational continuity. The serial number-based approach ensures precise targeting of devicesspecific acrossdevices, multiplepreventing locations, where physical access for maintenanceaccidental operations wouldon beunintended impractical or costly.equipment.

---

Endpoints

PUT /inventory_device_serial_operation/{serial_number}/

Description: Executes a specifiedmanagement operation on a specific device identified by its serial number. This endpoint supportsallows variousyou to remotely control device managementbehavior, operationsperform includingmaintenance reboots, factory resets, configuration synchronization,operations, and reconfiguration.manage Thedevice operationconfigurations iswithout executedrequiring immediatelyphysical uponaccess successfulto requestthe processing.hardware.

Use Cases:

• Remotely restartrebooting a device that has become unresponsive or isneeds experiencinga connectivityrestart issuesafter configuration changes
• PerformPerforming factory resetresets onwhen repurposing devices beingfor reassigneddifferent deployments

Synchronizing device configurations to differentensure userscompliance with organizational policies Reconfiguring devices with updated settings after policy or locationsnetwork changes SynchronizeTroubleshooting device configurationissues afterthrough updatingsystematic policiesreset or settings in the management system Trigger deviceand reconfiguration when network parameters or security settings change Reset device settings while preserving core device firmware (device factory reset)procedures

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_operation/ABC123456789/

Parameters:

Parameter	Type	In	Required	Description
serial_number	string	path	Yes	The unique serial number of the device to operateperform the operation on
dataoperation	string	body	Yes	JSONThe payload containing thespecific operation to performexecute. Valid operations include: 'reboot' (restart device), 'factory' (complete factory reset), 'device_factory' (device-specific factory reset), 'sync' (synchronize configuration), 'reconf' (reconfigure device settings)

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 - Restart the device factory - Perform complete factory reset (all settings and data) device_factory - Perform device factory reset (preserves some core settings) sync - Synchronize device configuration with management server reconf - Trigger device reconfiguration process

cURL Example:

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

Example Request Body:

{
  "operation": "reboot"
}

Example Response:

{
  "id": 12345,
  "operation": "reboot"
}

Response Fields:

Field Type Description id integer Unique identifier for the operation request (read-only) operation string Confirmation of the operation that was executed

Response Codes:

Status	Description
200	Success - Operation has been initiated successfully
400	Bad Request - Invalid operation type or malformed request
401	Unauthorized - Invalid or missing authentication token
404	Not Found - Device with specified serial number not found
422	Unprocessable Entity - ValidDevice request formatexists but operation cannot beperform processedrequested operation

---

Operation Types Reference

Operation Code Operation Name Description reboot Device Reboot Performs a graceful restart of the device, maintaining current configuration 500factory InternalFactory ServerReset ErrorComplete -factory Serverreset, errorremoving duringall operationcustom executionconfigurations and returning to default state device_factory Device Factory Reset Device-specific factory reset that may preserve certain manufacturer settings sync Configuration Sync Synchronizes device configuration with centralized management system reconf Device Reconfigure Applies new configuration settings to the device

---

Common Use Cases

Use Case 1: Remote Device Troubleshooting

When devices become unresponsive or experienceexhibit connectivity issues, use the reboot operation to restart themthe device remotely. This is particularlyoften usefulthe forfirst devices deployedstep in remotetroubleshooting locationsbefore whereescalating physicalto accessmore isintensive difficult or costly.

Endpoints: PUT /inventory_device_serial_operation/{serial_number}/ with operation: "reboot"operations.

Use Case 2: Device ReassignmentRepurposing and RedeploymentDeployment

Before reassigningdeploying devices to new userslocations or locations,users, perform a factory reset to ensure all previous user data and configurations are removed. This maintains security and provides a clean slateconfiguration state, followed by sync operations to apply appropriate settings for the new deployments.

deployment

Endpoints: PUT /inventory_device_serial_operation/{serial_number}/ with operation: "factory"environment.

Use Case 3: Fleet Configuration Management Workflows

AfterUse updatingthe sync and reconf operations to maintain configuration consistency across device policies,fleets, security settings, or network configurations in your management system, trigger configuration synchronization to ensureensuring all devices receive the latest settings without manual intervention.

Endpoints: PUT /inventory_device_serial_operation/{serial_number}/comply with operation:organizational "sync"security policies and operational requirements.

Use Case 4: Automated Maintenance SchedulesWorkflows

Integrate devicethese operations into automated maintenance workflowsschedules, that can performperforming regular rebootsconfiguration during off-hours, sync configurations after policy updates,syncs or prepareimplementing devicesautomated forrecovery redeploymentprocedures aswhen partdevice ofmonitoring lifecyclesystems managementdetect processes.

Endpoints: PUT /inventory_device_serial_operation/{serial_number}/ with various operations based on maintenance requirementsissues.

Use Case 5: Emergency Response and Recovery

In emergencycase situations where devices need immediate reconfiguration (such asof security incidents or networkwidespread changes),configuration issues, use thefactory reconfigurationreset operationoperations to quickly updatereturn devicedevices settingsto withoutknown-good waitingstates, forfollowed standardby synchronizationreconfiguration cycles.

to

Endpoints:restore PUTproper /inventory_device_serial_operation/{serial_number}/operational with operation: "reconf"settings.

---

Best Practices

Operation Selection:Timing

:

Be Usemindful rebootthat fordevice routineoperations troubleshootingmay take several minutes to complete. Implement appropriate timeouts and afterstatus configurationchecking changes that require a restart Choose factory for complete device reset when reassigning or decommissioning devices Select device_factory when you need to reset user settings but preserve core device firmware and basic configurations Implement sync operations after any policy or configuration updatesmechanisms in your managementapplications. system Use reconf

Serial Number Validation: Always verify serial numbers before executing operations. Invalid serial numbers will result in 404 errors, but valid serial numbers for immediatedevices configurationin changesincorrect thatstates cannotmay waitcause unexpected behavior.

Operation Sequencing: When performing multiple operations on the same device, allow sufficient time between operations for scheduledthe synchronizationdevice to complete each task. Factory resets typically require the most time.

Error Handling:

Always check the response status code before proceeding with additional operations Implement retry logic with exponential backoff for temporary network issues Log operation requestsMonitoring and responsesLogging: Implement comprehensive logging of all device operations for audit trails and troubleshootingtroubleshooting. Track operation initiation, completion, and any failure states. Handle 404

Error errorsHandling: gracefullyDesign whenrobust serialerror numbershandling for network timeouts, device unavailability, and operation failures. Some operations may notfail existif devices are offline or in themaintenance systemmode.

Security Considerations:Considerations

:

Validate serial numbers before making requests to prevent unauthorized device access Use secure token storage and rotation practices for API authentication Log allTreat device operations foras securityprivileged auditingactions. Implement appropriate authorization checks and complianceconsider requirementsimplementing additional confirmation steps for destructive operations like factory resets. Implement

Batch Operations: For fleet management scenarios, implement proper rate limiting toand preventerror accidentalrecovery masswhen performing operations thatacross could disrupt services

Performance and Reliability:

Allow sufficient time between operations on the same device to ensure completion Monitor operation success rates and device response times to identify problematicmultiple devices Implement proper timeout handling as device operations may take time to complete Consider device time zones and usage patterns when scheduling automated operations

Integration Tips:

Store operation IDs returned in responses for tracking and correlation with device logs Implement webhooks or polling mechanisms to monitor operation completion status Use device serial numbers consistently across all inventory management systems Validate device operational status before attempting operations to avoid conflictsoverwhelming the management infrastructure.