Inventory Device Name Headless Operation

Endpoints Summary

Method Path Swagger GET /inventory_device_name_headless_operation/ Swagger ↗ POST /inventory_device_name_headless_operation/ Swagger ↗

---

The Inventory Device Name Headless Operation endpointsAPI enableenables automated remote management and monitoring of network devices through programmaticheadless operations. These endpoints allow you to performschedule and execute device operations likesuch as getting parameters,parameter values, setting configurations, adding objects, and deleting objects without manual intervention, making them ideal for bulk device management and automated 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 Name Headless Operation API category provides functionalityprogrammatic control over device management operations in your network infrastructure. This API is designed for executingnetwork automatedadministrators and developers who need to automate device configuration, monitoring, and maintenance tasks across multiple devices simultaneously.

Key Features:

Remote Device Operations: Execute get, set, add object, and delete object operations on network devices in yourBatch inventory.Processing: These endpoints are designed for scenarios where you need to perform bulk operations acrossManage multiple devices or integrate device management into automated workflows.

Key Concepts:

Headless Operations: Automated deviceand operations thatthrough runa withoutsingle userAPI interactioninterface DeviceFlexible VariablesVariable Management: TR-069/CWMPSupport parametersfor thatvarious candata betypes retrieved,including modified,integers, orbooleans, managedand on devicesstrings OperationStatus TypesMonitoring: FourOptional mainreal-time operationstatus typesupdates areusing supported:configured

get: Retrieve parameter values from devices set: Update parameter values on devices add.obj: Create new object instances on devices del.obj: Remove object instances from devices helpers

Common Use Cases:

• Automated device configuration deployment

Periodic parameter monitoring and data collection Bulk configurationdevice settings updates across deviceyour fleetsnetwork AutomatedNetwork monitoringmaintenance and statustroubleshooting collection Scheduled maintenance operationsautomation Integration with network management systems Device provisioning and deprovisioningmonitoring workflowstools

The API supportsoperates complexon variableTR-069/CWMP operationsprotocol standards, allowing you to interact with typedevice validationparameters andusing providesstandard real-timedevice statusmodel updatespaths to(e.g., help monitor operation progress.Device.ManagementServer.PeriodicInformInterval).

---

Endpoints

GET /inventory_device_name_headless_operation/

Description: Retrieves a list of scheduled or completed headless operations for devicesnetwork in your inventory.devices. This endpoint allows you to monitor the status ofexisting operations, filtercheck bytheir specific transaction IDs,status, and optionally update device status information before returning results.

Use Cases:

• Monitor the progressstatus of bulkscheduled device operations
• Retrieve results from previously executed headless operations

Check the status of scheduled device maintenance tasks Audit device operation history for complianceauditing reportingand troubleshooting Check pending operations before scheduling new ones Update device status information for real-time monitoring

Full URL Example:

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

Parameters:

Parameter	Type	In	Required	Description
id	string	query	No	ID of the specific scheduled transaction to filter resultsretrieve
update_status	boolean	query	No	UseWhen true, uses configured helpers to update device status before returning information

cURL Example:

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

Example Response:

[
  {
    "name": "router-branch-01"office-001",
    "operation": "get",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval"
      },
      {
        "variable_name": "Device.WiFi.SSID.1.Stats.BytesReceived"
      }
    ]
  },
  {
    "name": "switch-floor-02"router-office-002",
    "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 list of headlessscheduled operations
401	Unauthorized - Invalid or missing API token
404	Not Found - NoSpecified operationstransaction foundID fordoes specifiednot criteriaexist

500 Internal Server Error - Server processing error

---

POST /inventory_device_name_headless_operation/

Description: Creates a new scheduled headless operation for onea ornetwork more devices in your inventory.device. This endpoint allows you to scheduledefine automateddevice operations such asincluding parameter retrieval, configuration updates,changes, object creation,management, orand objectvariable deletion across your device fleet.assignments.

Use Cases:

• ExecuteSchedule bulkautomatic parameter retrieval from devices

Deploy configuration changes acrossto multiplenetwork devices ScheduleAdd automatednew parameterobjects collectionto fordevice monitoringconfigurations ProvisionRemove newobsolete servicesconfiguration by adding object instancesobjects CleanAutomate uproutine unusedmaintenance configurations by removing object instancestasks

Full URL Example:

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

Parameters:

Parameter	Type	In	Required	Description
data	stringobject	body	Yes	JSON payload containingComplete operation detailsdefinition including device name, operation type, and variables

Request Body Schema:

{
  "name": "string (required)" - Name of the target device",
  "operation": "string (required,required) one- of:Operation type: get, set, add.obj, del.obj)"obj",
  "variables": [
    {
      "variable_name": "string (required)" - Device parameter path",
      "value": "string (optional,optional) required- Value for 'set'set operations)"operations",
      "value_type": "string (optional,optional) one- of:Data string,type: integer, boolean)"boolean, string"
    }
  ]
}

cURL Example -(GET Get Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_name_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name"Operation): "router-main-office",
    "operation": "get",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval"
      },
      {
        "variable_name": "Device.WiFi.SSID.1.Stats.BytesReceived"
      }
    ]
  }'

cURL Example - Set Operation:

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_name_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "router-branch-network"005",
    "operation": "get",
    "variables": [
      {"variable_name": "Device.ManagementServer.PeriodicInformInterval"},
      {"variable_name": "Device.WiFi.SSID.1.Enable"}
    ]
  }'

cURL Example (SET Operation):

curl -X POST "https://control.zequenze.com/api/v1/inventory_device_name_headless_operation/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "router-branch-005",
    "operation": "set",
    "variables": [
      {
        "variable_name": "Device.ManagementServer.PeriodicInformInterval",
        "value": "300"600",
        "value_type": "integer"
      },
      {
        "variable_name": "Device.ManagementServer.PeriodicInformEnable"WiFi.SSID.1.Enable",
        "value": "true",
        "value_type": "boolean"
      }
    ]
  }'

Example Response:

{
  "name": "router-main-office"branch-005",
  "operation": "get"set",
  "variables": [
    {
      "variable_name": "Device.ManagementServer.PeriodicInformInterval",
      "value": "600",
      "value_type": "integer"
    },
    {
      "variable_name": "Device.WiFi.SSID.1.Stats.BytesReceived"Enable",
      "value": "true",
      "value_type": "boolean"
    }
  ],
  "transaction_id": "op_67890",
  "status": "scheduled",
  "created_at": "2024-01-15T14:30:00Z"
}

Response Codes:

Status	Description
201	Created - Operation successfully scheduled
400	Bad Request - Invalid operation parameters or malformed requestJSON
401	Unauthorized - Invalid or missing API token
404	Not Found - Specified device does not foundexist

in inventory 422 Unprocessable Entity - Valid JSON but invalid operation configuration

---

Common Use Cases

Use Case 1: BulkAutomated WiFi Configuration Update

Schedule set operations across multiple access points to update WiFi settings like channel, power, or security configurations during maintenance windows.

Use Case 2: Network HealthDevice Monitoring

Use get operations toRegularly collect device statistics and performance metrics from multiple network devices onfor monitoring dashboards and alerting systems.

Endpoints: GET to check existing operations, POST to schedule new monitoring tasks

Use Case 2: Bulk Configuration Deployment

Deploy standardized configuration settings across multiple devices in a schedulednetwork, basissuch foras networkupdating monitoringsecurity andparameters reportingor dashboards.Wi-Fi settings.

Endpoints: POST to create set operations with standardized variable values

Use Case 3: ServiceNetwork ProvisioningMaintenance Automation

ImplementAutomate routine maintenance tasks like clearing statistics, updating inform intervals, or managing device objects during scheduled maintenance windows.

Endpoints: POST with add.obj and del.obj operations tofor createobject new service instances (like VLANs, SSIDs, or port configurations) when onboarding new customers or locations.management

Use Case 4: AutomatedDevice ComplianceStatus CheckingVerification

RegularlyVerify execute get operations to verifycurrent device configurations meet compliance requirements and generatesettings auditafter reports.deployment or troubleshooting to ensure consistency across the network.

Endpoints: GET with update_status=true to retrieve real-time device information

Use Case 5: CleanupIntegration with Network Management Systems

Integrate with existing NMS platforms to provide automated device management capabilities through API calls.

Endpoints: Both GET and MaintenancePOST

Usefor del.objcomprehensive operationsdevice tooperation remove unused configurations, expired certificates, or decommissioned service instances during routine maintenance.management

---

Best Practices

Operation Planning:Types:

• TestUse get operations onfor anon-intrusive smallparameter subsetretrieval ofand devices before executing bulk operationsmonitoring
• Use the update_status=trueset parameteroperations whencarefully youas needthey currentmodify device informationconfigurations
• MonitorTest operationadd.obj resultsand usingdel.obj theoperations GETin endpointdevelopment withenvironments transactionbefore IDsproduction deployment

Variable Management:

• Always specifyvalidate the correct value_type for set operations to ensure proper parameter validation

Use fully qualified TR-069device parameter paths for better compatibility across device types Validate variable names against your device's data model before executingcreating operations

Error Handling:

• Implement retry logic for operationsnetwork-related that may fail due to temporary network issuesfailures
• Check device connectivity status before scheduling operations
• Monitor operation statusresults and implement timeoutappropriate error handling for long-runningfailed operations

Security Considerations:

Limit access to headless operation endpoints to authorized automation systems only Log all operations for audit trails and troubleshooting Use least-privilegethe principlesupdate_status parameter to get real-time device status when granting API access for automated systemsneeded

Performance Optimization:

• Batch related operations together when possible to reduce API calls
• ConsiderUse specific transaction IDs when retrieving operation status to improve query performance

Schedule operations during maintenance windows for configuration changes Monitor API rate limits and implement appropriate throttling

Security Considerations:

Store API tokens securely and rotate them regularly Validate all input parameters before sending requests Use HTTPS for all API communications Implement proper access controls for device capabilities and network conditions when schedulingmanagement operations ImplementLog rateall limitingconfiguration inchanges yourfor automationaudit scriptstrails

Data Type Guidelines:

Always specify value_type for set operations to avoidensure overwhelmingproper devicesparameter handling Use appropriate data types: "integer" for numeric values, "boolean" for true/false, "string" for text Validate parameter values against device specifications before submission

---