Skip to main content

Inventory Device Serial Headless Operation

Endpoints Summary

Method Path Swagger GET /inventory_device_serial_headless_operation/ Swagger ↗ POST /inventory_device_serial_headless_operation/ Swagger ↗

The Inventory Device Serial Headless Operation endpoints enable programmatic control of device operations through serial number identification. These endpoints allow you to schedule and retrievemanage automated device operations on network devices using their serial numbers. These endpoints enable you to perform TR-069/CWMP operations like getting device parameters, setting configurations,configuration values, and managing objects without manual intervention, making them ideal for automated device management workflows.intervention.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Device Serial Headless Operation API provides a powerful interfaceway forto managingmanage devicenetwork operationsdevices programmatically usingthrough devicescheduled serial numbers.operations. This API category is specifically designed for automatedautomating device management scenarios where you need to perform bulk operations or scheduled maintenance tasks acrosson multipleTR-069/CWMP compatible devices withoutusing manualtheir intervention.serial numbers as identifiers.

Key Capabilities:

  • DeviceGet Parameter ManagementOperations: GetRetrieve andcurrent setparameter devicevalues configurationfrom parametersdevices using(e.g., TR-069/CWMPWiFi variablestatistics, pathsmanagement server settings)
  • Set Operations: Configure device parameters remotely (e.g., periodic inform intervals, enable/disable features)
Add Object Operations: AddCreate or deletenew configuration objects on devices BulkDelete Object Operations: ExecuteRemove theexisting sameconfiguration operationobjects across multiplefrom devices simultaneously Scheduled Transactions: Track and monitor operation status through unique transaction IDs Status Updates: Real-time device status updates using configured helpers

Common IntegrationUse Scenarios:Cases:

  • Automated device provisioning and configuration managementdeployment across multiple devices
  • Scheduled maintenance tasks like firmware updates or parameter adjustmentscollection for monitoring and analytics
  • Bulk configuration changes across device fleets
management Monitoring and reporting on device parameter valuesoperations Remote troubleshooting and diagnostics Compliance checking and configuration validation

The APIoperations usesare TR-069/CWMPexecuted dataasynchronously, modelallowing variable paths (e.g., Device.ManagementServer.PeriodicInformInterval)you to identifyschedule specifictasks devicethat parameterswill andbe supportsperformed multiplewhen datadevices typesnext includingcommunicate integers,with booleans,the andmanagement stringsserver. forThe setoptional operations.update_status parameter enables real-time status updates before returning operation results.

Endpoints

GET /inventory_device_serial_headless_operation/

Description: Retrieves a list of scheduled headless operations for devices,devices. allowingThis endpoint allows you to view pending, completed, or filtered operations based on transaction ID. Use this to monitor operationthe status andof results.your Thisscheduled endpointdevice supports filtering by transaction IDoperations and canretrieve optionally update device status before returning information.results.

Use Cases:

  • Monitor the progress and resultsstatus of previously scheduled device operations
  • Retrieve operationresults detailsfrom forcompleted specificdevice transactionsparameter using the ID filterqueries
  • GetCheck updatedpending deviceoperations statusbefore informationscheduling alongnew with operation resultsones
  • Audit andtrail trackof device management activities

Full URL Example:

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

Parameters:

Parameter Type In Required Description
id string query No ID of the scheduled transaction to filter results
update_status boolean query No Use configured helpers to update device status before returning the information

cURL Example:

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

Example Response:

[
  {
    "serial_number": "SN123456789"DV001234567890",
    "operation": "get",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300",
        "status": "completed"
      },
      {
        "variable_name": "Device.WiFi.SSID.1.SSID"Stats.BytesReceived",
        "value": "1048576000",
        "status": "completed"
      }
    ]
  },
  {
    "serial_number": "SN987654321"DV001234567891",
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300"60",
        "value_type": "integer",
        "status": "pending"
      }
    ]
  }
]

Response Codes:

Status Description
200 Success - Returns arraythe list of scheduled operations
401 Unauthorized - Invalid or missing API token
404403 Not FoundForbidden - NoInsufficient operationspermissions
found forspecified500 criteriaInternal Server Error - Server processing error

POST /inventory_device_serial_headless_operation/

Description: Creates a new scheduled headless operation for aone deviceor identifiedmore by serial number.devices. This endpoint schedulesallows you to queue device operations like parameter retrieval, configuration changes, or object management that will be executed automatically.when the target devices next communicate with the management server. Support for get, set, add object, and delete object operations.

Use Cases:

  • Schedule parameter retrieval from multiple devices for monitoring
Deploy configuration changes across multiplea fleet of devices Retrieve specific parameter values for monitoring or reporting Add new configuration objects to devices (e.g., new WiFi SSIDs)SSIDs or network configurations remotely Remove obsolete configuration objects from devices Automate device provisioning workflows

Full URL Example:

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

RequestParameters:

Body:
Therequest Parameter Type In Required Description data object body shouldYes containJSON object containing the operation details in JSON format.

Request Body Schema:

{
  "serial_number": "string",
  "operation": "get|set|add.obj|del.obj",
  "variables": [
    {
      "variable_name": "string",
      "value": "string",
      "value_type": "string|integer|boolean"
    }
  ]
}

cURL Example - Get Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "serial_number": "SN123456789"DV001234567890",
    "operation": "get",
    "variables": [
      {"variable_name": "Device.ManagementServer.PeriodicInformInterval"},
      {"variable_name": "Device.WiFi.SSID.1.SSID"Stats.BytesReceived"}
    ]
  }'

cURL Example - Set Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_serial_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "serial_number": "SN123456789"DV001234567890",
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300"60",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable",
        "value": "true"1",
        "value_type": "boolean"
      }
    ]
  }'

Request Schema:

Field Type Required Description serial_number string Yes Serial number of the target device operation string Yes Operation type: get, set, add.obj, or del.obj variables array No Array of variable objects with operation-specific properties

Variable Object Schema:

For Get/Add Object/Delete Object operations:

Field Type Required Description variable_name string Yes TR-069/CWMP variable path

For Set operations:

Field Type Required Description variable_name string Yes TR-069/CWMP variable path value string Yes Value to set (as string) value_type string Yes Data type: integer, boolean, or string

Example Response:

{
  "id": "txn_789012345",
  "serial_number": "SN123456789"DV001234567890",
  "operation": "set",
  "variables": [
    {
      "variable_name": "Device.ManagementServer.PeriodicInformInterval",
      "value": "300"60",
      "value_type": "integer"
    },
    {
      "variable_name": "Device.ManagementServer.PeriodicInformEnable",
      "value": "1",
      "value_type": "boolean"
    }
  ],
  "status": "scheduled",
  "created_at": "2024-01-15T10:30:00Z"
}

Response Codes:

Status Description
201 Created - Operation successfully scheduled
400 Bad Request - Invalid requestoperation dataparameters or parametersmalformed request
401 Unauthorized - Invalid or missing API token
403 Forbidden - Insufficient permissions 404 Not Found - Device with specified serial number not found 422 Unprocessable Entity - Valid JSON but invalid operation data

Common Use Cases

Use Case 1: Bulk Device Configuration UpdateMonitoring

Schedule periodic retrieval of key configuration changesparameters across multiple devices byto creatingensure separatecompliance with corporate policies. Use GET operations forto eachcollect deviceparameters seriallike number.periodic Monitorinform progressintervals, usingWiFi thesettings, GETand endpointsecurity with transaction IDs.configurations.

Use Case 2: Automated Device Health MonitoringOnboarding

RegularlyWhen retrievenew keydevices deviceare deployed, use SET operations to automatically configure management server settings, WiFi credentials, and other essential parameters likewithout uptime,requiring signalmanual strength, and error counters by scheduling get operations for specific variables across your device fleet.intervention.

Use Case 3: AutomatedWiFi ProvisioningNetwork Management

SetUse up new devices by scheduling a series of setADD.OBJ operations to configuredeploy new WiFi SSIDs across all access points, or DEL.OBJ operations to remove obsolete network settings, management parameters, and service configurations basedduring onnetwork device serial numbers.updates.

Use Case 4: WiFiPerformance NetworkMonitoring Managementand Analytics

AddSchedule newGET WiFi SSIDsoperations to devicescollect usingdevice add.objstatistics operations,like orbytes removetransmitted/received, obsoleteconnection networkscounts, usingand del.objperformance operations,metrics targetingfor specificanalysis TR-069and WiFi object paths.reporting.

Use Case 5: ComplianceSecurity ReportingConfiguration Updates

ScheduleUse regular getSET operations to retrieveupdate security andparameters, configurationchange parametersdefault neededpasswords, foror compliancemodify reporting,firewall usingsettings theacross update_statusmultiple flagdevices to ensure current data.simultaneously.

Best Practices

  • TransactionOperation TrackingScheduling: Remember that operations are executed when devices next communicate with the management server. Consider device periodic inform intervals when planning time-sensitive operations.

Variable Naming: Use complete TR-069/CWMP parameter paths (e.g., Device.ManagementServer.PeriodicInformInterval) to ensure proper parameter identification.

Value Types: Always storespecify the transactioncorrect IDsvalue_type returnedfor from POSTSET operations (string, integer, boolean) to monitorprevent type conversion errors on the device.

Batch Operations: Group related parameters in a single operation request to minimize the number of device communications required.

Error Handling: Monitor operation status and results using the GET endpoint

and Error Handling: Implementimplement retry logic for failed operationsoperations. and checkCheck device connectivity beforeif schedulingoperations criticalremain configurationpending changesfor extended periods.

BatchSecurity ProcessingConsiderations: When updating multiple devices, implement proper rate limiting to avoid overwhelming the API or target devices

Variable Path Validation: Verify TR-069/CWMP variable paths are correct for yourValidate device modelsserial numbers before scheduling operations and ensure proper access controls are in place for sensitive configuration parameters. Data Type Consistency: Ensure value_type matches the actual parameter type expected by the device (integer, boolean, string)

Status Updates: Use the update_statusupdate_status=true parameter judiciouslywhen asyou itneed real-time status information, but be aware this may addincrease latencyresponse totimes GETfor requests but ensures currentlarge device information

inventories. Security: Never include sensitive credentials or keys in variable values; use secure provisioning methods for authentication parameters
Back to top