Inventory Device Headless Operation

Endpoints Summary

Method Path Swagger GET /inventory_device_headless_operation/ Swagger ↗ POST /inventory_device_headless_operation/ Swagger ↗

---

The Inventory Device Headless Operation API enables automated device management operations withouton requiringnetwork userdevices interfacethrough interactions.programmatic control. These endpoints allow you to schedule and execute device operations likesuch parameteras retrieval,retrieving configurationparameters, updates,setting configurations, and objectmanaging objects without manual intervention, making them ideal for bulk device management acrossand yourautomated device inventory programmatically.workflows.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Inventory Device Headless Operation API provides a powerful interface for managing devicenetwork operationsdevices at scale through automated, programmatic interactions.programmatically. This API category isfocuses designedon forexecuting systemoperations administratorson anddevices developersthat whoare needpart toof performyour bulkinventory devicewithout operations,requiring scheduledirect maintenanceuser tasks, or integrate device management into larger automation workflows.interaction.

Key Concepts:Capabilities:

• HeadlessGet Operations: DeviceRetrieve managementspecific tasksparameter thatvalues executefrom withoutdevices user(e.g., interfaceconfiguration interaction,settings, idealstatistics, fordevice automation and batch processinginformation)
• OperationSet TypesOperations: Four primary operations supported - Get (retrieve parameters), Set (update configurations), Add Object (create newUpdate device objects),configurations andby Deletesetting Objectparameter (removevalues devicewith objects)specified data types
• VariableAdd ManagementObject Operations: FlexibleCreate parameter system supporting different data types (integer, boolean, string) for devicenew configuration objects on devices dynamically
• TransactionDelete TrackingObject Operations: EachRemove operationexisting isconfiguration assignedobjects afrom unique ID for monitoring and status trackingdevices

Common IntegrationUse Scenarios:Cases:

• Bulk configuration updates across multiple devices

Automated device provisioningmonitoring and configurationparameter managementcollection Scheduled maintenance operations across device fleets Real-timeDynamic device parameter monitoring and alerting Bulk configuration updates during system migrations Integration with third-partyWi-Fi network management systemsDevice compliance checking and reporting Remote troubleshooting and diagnostics

The operations are designed to work with TR-069/CWMP compatible devices and support standard device management protocols. All operations can be tracked and their status updated using the built-in helpers.

---

Endpoints

GET /inventory_device_headless_operation/

Description: Retrieves a list of scheduled orheadless completedoperations devicefor operations.devices in your inventory. This endpoint allows you to monitor the status of headlessexisting operations, trackcheck their progress,configuration, and retrieveoptionally operation results. You can filter by specific operation IDs or request real-timeupdate device status updates.before returning the information. Use this to track ongoing operations or verify operation parameters before execution.

Use Cases:

• Monitor the progressstatus of bulk device configuration updates

Retrieve results from scheduled device parameter collection tasks Track the status of automated device provisioning operations Verify operation parameters before execution Audit historical device management activities Retrieve specific operation details by ID

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_headless_operation/?id=12345&update_status=true

Parameters:

Parameter	Type	In	Required	Description
id	string	query	No	ID of the specific scheduled transaction to retrieveretrieve. specificIf provided, returns only that operation details
update_status	boolean	query	No	When true, uses configured helpers to refreshupdate device status before returning information

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_headless_operation/?update_status=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

[
  {
    "id": 12345,
    "operation": "get",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval"
      },
      {
        "variable_name": "Device.WiFi.SSID.2.Stats.BytesReceived"1.SSID"
      },
      {
        "variable_name": "Device.DeviceInfo.SerialNumber"
      }
    ]
  },
  {
    "id": 12346,
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable",
        "value": "1",
        "value_type": "boolean"
      }
    ]
  }
]

Response Codes:

Status	Description
200	Success - Returns arraythe list of operationscheduled objectsoperations
401	Unauthorized - Invalid or missing API token
404	Not Found - SpecifiedSpecific operation ID does not existfound

---

POST /inventory_device_headless_operation/

Description: Creates a new headless operation for a device operationin your inventory. This endpoint schedules operations to be executed on targetnetwork devices.devices, This endpoint allows you to schedule device management tasks such asincluding parameter retrieval, configuration updates, orand object management operations.management. The operation will be queued for execution and canexecuted beaccording monitoredto usingyour thesystem's GETscheduling endpoint.configuration.

Use Cases:

• Schedule bulk configuration updates across multiple devices
• InitiateSet up automated device parameter collection for monitoring
• Create objectnew managementWi-Fi operationsSSIDs foror devicenetwork provisioningconfigurations
• SetRemove upoutdated recurringconfiguration objects

Implement automated device maintenance tasksroutines

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_headless_operation/

Parameters:

Parameter	Type	In	Required	Description
data	string	body	Yes	JSON payload containing the operation details including device ID, operation type, and variables

Request Body Structure:

{
  "id": 12345,
  "operation": "get|set|add.obj|del.obj",
  "variables": [
    {
      "variable_name": "Device.Parameter.Name",
      "value": "parameter_value",
      "value_type": "string|integer|boolean"
    }
  ]
}

cURL Example:Example - Get Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 67890,
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "600",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable",
        "value": "1",
        "value_type": "boolean"
      }
    ]
  }'

Example Request Body (Get Operation):

{
  "id": 67890,12345,
    "operation": "get",
    "variables": [
      {
      "variable_name": "Device.ManagementServer.PeriodicInformInterval"
    },
      {
      "variable_name": "Device.WiFi.SSID.1.BSSID"SSID"},
      {"variable_name": "Device.DeviceInfo.ModelName"}
    ]
  }'

cURL Example Request- Body (Set Operation):Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "id": 67890,12345,
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable"WiFi.SSID.1.SSID",
        "value": "true"MyNewNetwork",
        "value_type": "boolean"string"
      }
    ]
  }'

Example Response:

{
  "id": 67890,12345,
  "operation": "set",
  "variables": [
    {
      "variable_name": "Device.ManagementServer.PeriodicInformInterval",
      "value": "300",
      "value_type": "integer"
    },
    {
      "variable_name": "Device.ManagementServer.PeriodicInformEnable"WiFi.SSID.1.SSID",
      "value": "true"MyNewNetwork",
      "value_type": "boolean"string"
    }
  ]
}

Response Codes:

Status	Description
201	Created - Operation successfully scheduled
400	Bad Request - Invalid operation data or parameters
401	Unauthorized - Invalid or missing API token
422404	UnprocessableNot EntityFound - ValidDevice JSONID butnot invalidfound operationin parametersinventory

---

Common Use Cases

Use Case 1: Bulk DeviceWi-Fi Configuration Update

Schedule configuration changesupdates across multiple devicesaccess bypoints creatingto setchange operationsSSID fornames, eachpasswords, device.or Monitorsecurity progresssettings. usingUse the GETset endpointoperation with Wi-Fi related parameters to trackupdate completionnetwork statusconfigurations and identify any failed operations.remotely.

Use Case 2: AutomatedDevice DeviceHealth Monitoring

CreateSet recurringup automated parameter collection using get operations to monitor device status, performance metrics, and configuration drift. Schedule regular retrieval of key parameters like uptime, memory usage, and connection statistics.

Use Case 3: Dynamic Network Object Management

Use add.obj and del.obj operations to dynamically manage network configurations such as creating new SSID instances, adding firewall rules, or managing VLAN configurations based on business requirements.

Use Case 4: Compliance Auditing

Implement automated compliance checking by retrieving configuration parameters and comparing them against organizational standards. Use get operations to collect current settings for security auditing purposes.

Use Case 5: Remote Troubleshooting

Schedule diagnostic operations to collect device parameters for monitoring dashboards. Use the update_status parameter to ensure real-time data collection for critical metrics.

Use Case 3: Device Provisioning Workflow

Combine add.obj operations to create new device objects during automated provisioning, followed by set operations to configure initial parametersinformation and getstatistics operationswhen toissues verifyare successfulreported. deployment.

Use Case 4: Network Maintenance Automation

Schedule device parameter collection before maintenance windows, perform configuration updates, and validate changes afterward using a combination of get and set operations.

Use Case 5: Compliance Auditing

Use get operations to periodicallygather collectcomprehensive device configurationstate parametersinformation andfor compare against compliance baselines, automatically generating reports of configuration drift.troubleshooting.

---

Best Practices

• Operation SequencingPlanning: WhenAlways performing multipletest operations on thea samesmall device,subset allowof sufficientdevices timebefore betweenscheduling bulk operations toacross ensureyour properentire execution and avoid conflictsinventory
• Error Handling: Always check operation status using the GET endpoint before assuming success, especially for critical configuration changes

Batch Processing: Group related operations by device or operation type to optimize execution efficiency and simplify monitoring VariableParameter Validation: Verify variableparameter names and datapaths typesare correct for your device models before creating operationsoperations, toas preventincorrect executionparameters may cause operation failures Status Monitoring: Use the update_statusupdate_status=true parameter judiciouslywhen asretrieving itoperations mayto impactget APIthe responsemost times for largecurrent device inventoriesstatus information TransactionError LoggingHandling: StoreImplement operationproper IDserror handling for failed operations and consider retry mechanisms for transient failures Security: Limit the scope of operations and use appropriate authentication tokens with minimal required permissions Scheduling: Consider device load and network capacity when scheduling multiple operations, especially during business hours Documentation: Keep detailed records of scheduled operations for audit trails and troubleshooting purposes Rate Limiting: Implement appropriate delays between API calls to respect system limits and ensure reliable operation execution

---