Inventory Device Name Operation

TheThis API category enables remote device management operations for inventory devicedevices namewithin operationthe endpointZequenze allowsplatform. youIt provides endpoints to updateperform critical device informationoperations bylike referencingreboots, thefactory device'sresets, name.configuration synchronization, and reconfiguration tasks programmatically. This is particularly usefulessential for batchIT operationsadministrators ormanaging whenlarge youfleets of devices who need to modifyexecute devicemaintenance dataoperations remotely without knowingphysical the specific device ID.access.

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 Operation API provides functionality to update device records in your inventory management system using the device name asoperation theAPI identifier.allows administrators to remotely execute critical maintenance and configuration operations on managed devices. This approachAPI is especiallyparticularly valuable in scenarios where device names are unique and well-known identifiers within your organization, eliminating the need to first retrieve device IDs.

This endpoint is commonly used for:

• Remote Device Management: Execute operations on devices across multiple locations without physical access

Bulk Maintenance Operations: Programmatically perform maintenance tasks across device updatesfleets where Automated Device Recovery: Integrate device namesrecovery areoperations theinto primarymonitoring referenceand alerting systems Integration withConfiguration externalManagement: systemsSynchronize thatdevice trackconfigurations devicesand by name Automated inventory management workflows Device configurationpush updates based on naming conventionsremotely

The API followssupports RESTfulfive principlescore operations: reboot, factory reset, device-specific factory reset, configuration synchronization, and acceptsdevice JSON-formattedreconfiguration. dataEach operation is executed asynchronously, allowing for safe management of devices that may temporarily lose connectivity during the operation.

Important Concepts:

Operations are identified by device updates.name rather than ID for easier integration All operations requireare proper authenticationasynchronous and returnmay detailedtake response informationtime to helpcomplete withDevice errorconnectivity handlingmay andbe confirmationtemporarily ofinterrupted successfulduring updates.certain operations Operation status should be monitored through other inventory endpoints

---

Endpoints

PUT /inventory_device_name_operation/{name}/

Description: UpdatesExecutes ana existingspecified operation on a device recordidentified inby theits inventory system using the device name as the identifier.name. This endpoint allowsis youthe toprimary modifymechanism for remotely managing device attributesstates, suchperforming asmaintenance status,tasks, location,and configuration,updating orconfigurations. metadataThe withoutoperation needingis toqueued knowand executed asynchronously on the device'starget internal ID.device.

Use Cases:

• UpdateRemotely devicereboot statusunresponsive afterdevices maintenanceto operationsrestore functionality
• ModifyPerform devicefactory location when equipment is moved

Bulk update device configurations basedresets on namingdevices patternsbeing reassigned or decommissioned Synchronize device informationconfigurations fromafter externalpolicy assetupdates managementReconfigure systemsdevices with new network or security settings Execute maintenance operations during scheduled maintenance windows

Full URL Example:

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

Parameters:

Parameter	Type	In	Required	Description
name	string	path	Yes	The unique name identifier of the device to update. Must match exactly with thetarget device name in the inventory system
data	string	body	Yes	JSON stringpayload containing the deviceoperation fieldsdetails toand update. Can include status, location, metadata, configuration settings, or other device attributesparameters

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 standard device restart factory: Executes a complete factory reset, removing all configurations and data device_factory: Performs a device-specific factory reset (preserves certain device-level settings) sync: Synchronizes device configuration with the management server reconf: Reconfigures device with updated settings and policies

cURL Example:

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

Example Request Bodies:

Reboot Operation:

{
  "location"operation": "Datareboot"
Center}
B

-

Factory RackReset 15",Operation:

{
  "last_maintenance"operation": "2024-01-15T14:30:00Z",factory"
}

Configuration Sync Operation:

{
  "notes"operation": "Scheduled maintenance completed",
    "configuration": {
      "cpu_cores": 16,
      "memory_gb": 64,
      "storage_type": "SSD"sync"
}
  }'

Example Response:

{
  "id": 1247,
  "name"operation": "server-web-01",
  "status": "maintenance",
  "device_type": "server",
  "serial_number": "SRV2024-001247",
  "location": "Data Center B - Rack 15",
  "organization": "IT Department",
  "last_maintenance": "2024-01-15T14:30:00Z",
  "notes": "Scheduled maintenance completed",
  "configuration": {
    "cpu_cores": 16,
    "memory_gb": 64,
    "storage_type": "SSD",
    "network_ports": 4
  },
  "created_at": "2023-08-10T09:15:00Z",
  "updated_at": "2024-01-15T14:35:22Z",
  "is_active": truereboot"
}

Response Codes:

Status	Description
200	Success - DeviceOperation updatedqueued successfully,successfully returnsand will be executed on the complete updated device record
400	Bad Request - Invalid JSONoperation datatype or missingmalformed requiredrequest fieldsdata
401	Unauthorized - Invalid or missing API token
404	Not Found - Device with the specified name does not exist in inventory
422	Unprocessable Entity - ValidDevice JSONexists but invalidcannot fieldperform valuesthe orrequested constraintsoperation (e.g., device offline)

500 Internal Server Error - Server error occurred while processing the request

---

Common Use Cases

Use Case 1: ScheduledAutomated MaintenanceDevice UpdatesRecovery

When performingmonitoring routinesystems maintenancedetect onunresponsive devices, useautomatically thistrigger a reboot operation to restore functionality without manual intervention.

Example Workflow:

Monitoring system detects device is unresponsive Call the operation endpoint towith update"operation": the"reboot" Monitor device status andthrough maintenanceinventory records.endpoints Thisto helpsconfirm trackrecovery maintenance history and current device availability.

Use Case 2: LocationBulk TrackingDevice Maintenance

AsSchedule maintenance operations across multiple devices areduring movedoff-hours betweenby locationsiterating (datathrough centers,device offices,names storageand facilities),executing updateoperations.

their

Example locationWorkflow:

information

toRetrieve maintainlist accurateof inventorydevices recordsrequiring maintenance For each device, call the operation endpoint with appropriate operation Log operation results for assetmaintenance managementrecords and support purposes.

Use Case 3: ConfigurationDevice Lifecycle Management

AfterWhen hardwaredevices upgradesare being reassigned or configurationdecommissioned, changes,perform updatefactory theresets to ensure data security and prepare devices for new deployment.

Example Workflow:

Identify devices for reassignment Execute factory operation to completely reset devices Verify reset completion before physical device specificationstransfer to reflect current capabilities. This is essential for capacity planning and resource allocation.

Use Case 4: ExternalConfiguration System IntegrationDeployment

SynchronizeAfter updating device informationpolicies betweenor yourconfigurations inventoryin the management system, synchronize all affected devices to apply the changes.

Example Workflow:

Update device policies in management system andExecute externalsync toolsoperation likeon monitoring systems, CMDB platforms, or asset management solutions that referenceaffected devices byMonitor name.configuration

Usestatus Caseto 5:ensure Batchsuccessful Processing

deployment

Process multiple device updates in automated workflows where device names follow predictable patterns, enabling efficient bulk operations for large-scale infrastructure management.

---

Best Practices

• UniqueOperation Device NamesTiming: EnsureSchedule deviceintensive namesoperations arelike uniquefactory acrossresets yourduring inventorymaintenance windows to preventminimize accidentalbusiness updates to wrong devices

Validate Data: Always validate JSON data structure before sending requests to avoid 400/422 errorsimpact Error Handling: ImplementAlways robustcheck errorresponse handlingstatus codes and implement retry logic for 404transient responsesfailures when(500 device names don't exist in the systemerrors) PartialDevice UpdatesState Monitoring: OnlyAfter includeexecuting fieldsoperations, thatmonitor needdevice status through inventory endpoints to beconfirm changedsuccessful in the request body - the API supports partial updatescompletion RateBatch LimitingProcessing: ForWhen bulkperforming operations,operations on multiple devices, implement appropriate delays between requests to avoid overwhelming the APIsystem Operation Logging: LogMaintain bothlogs successfulof updatesall andoperations errorsperformed for audit trails and troubleshooting purposes DataNetwork BackupConsiderations: ConsiderBe backingaware upthat currentfactory resets and reconfigurations may change device statenetwork beforesettings, makingpotentially significantaffecting changes,connectivity especially 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 automatedyour workflowsapplications

---

Error Handling and Troubleshooting

Common Issues:

Device Not Found (404)

Verify the device name is correct and matches the inventory exactly Check that the device exists in your organization's inventory Ensure proper URL encoding for device names with special characters

Operation Failed (422)

Device may be offline or unreachable Some operations may not be supported on specific device types Device may be in a state that prevents the requested operation

Authentication Issues (401)

Verify API token is valid and not expired Ensure token has sufficient permissions for device operations Check that the Authorization header is properly formatted