Inventory Device Serial Setting

These Retrieval:endpoints Queryare deviceparticularly settings using various filters such as parameter names, variable names, or parameter types

Common Integration Scenarios:

The API supports bothvarious fullparameter updatestypes (PUT)including strings, integers, booleans, and partialcomplex updatesdata (PATCH)types, with built-in support for maximumread-only flexibilityparameters, inmetrics configurationtracking, and parameter grouping.

The serial number-based approach ensures precise device targeting, while the flexible filtering system allows for efficient parameter management workflows.across large device inventories.

Endpoints

GET /inventory_device_serial_setting/

Description: Retrieves a paginated list of configurationdevice settings and configuration parameters for devicesa basedspecific ondevice theiridentified by its serial numbers.number. This endpoint is essential for viewing current device configurations, checkingmonitoring parameter values, and identifying pending changessetting across your device inventory.changes.

Use Cases:

• AuditRetrieve all configuration parameters for a specific device configurationsduring and parameter valuestroubleshooting
• CheckMonitor forwhich settings are pending configurationapplication changesto before maintenance windowsdevices
• Filter device settingsparameters by specifictype, parameter typesgroup, or namesvariable name for configuration audits
• GenerateExport configurationdevice reportsconfigurations for compliancebackup or documentationmigration purposes

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_setting/?parent__serial_number=ABC123456&parameter__name=network_configSN123456789&limit=2050&pending=true

Parameters:

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_serial_setting/?parent__serial_number=RTR001234SN123456789&parameter__name=interface_configwifi_password&limit=10" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 25,
  "next": "https://control.zequenze.com/api/v1/inventory_device_serial_setting/?limit=10&offset=10&parent__serial_number=RTR001234"SN123456789",
  "previous": null,
  "results": [
    {
      "id": 1001,
      "parent_id": "RTR001234"SN123456789",
      "parent__name": "Router-Branch-Office-01"Router_Building_A",
      "parameter": {
        "id": 45,
        "name": "WANWiFi Interface IP Address"Password",
        "short_name": "wan-ip"wifi-pass",
        "variable_name": "wan_interface_ip"wifi_password",
        "type": "string"password",
        "position": 1,10,
        "required": true,
        "read_only": false,
        "metric": false,
        "group": {
          "id": 3,5,
          "name": "NetworkWireless Configuration",
          "service": "routing"WiFi Management",
          "discovery_group": "network",
          "title": "NetworkWiFi Settings"
        }
      },
      "value": "192.168.100.1"SecurePassword123!",
      "extra": false,
      "extra_value": null,
      "created": "2024-01-15T10:30:00Z",
      "last_change": "2024-01-20T14:22:15Z"45:30Z",
      "pending": false
    },
    {
      "id": 1002,
      "parent_id": "RTR001234"SN123456789",
      "parent__name": "Router-Branch-Office-01"Router_Building_A",
      "parameter": {
        "id": 46,
        "name": "DHCPFirmware Pool Range"Version",
        "short_name": "dhcp-range"fw-ver",
        "variable_name": "dhcp_pool_range"firmware_version",
        "type": "string"readonly",
        "position": 2,1,
        "required": false,
        "read_only": false,true,
        "metric": false,true,
        "group": {
          "id": 3,1,
          "name": "NetworkSystem Configuration"Information",
          "service": "dhcp"System Management",
          "discovery_group": "network"system",
          "title": "NetworkDevice Settings"Info"
        }
      },
      "value": "192.168.100.100-192.168.100.200"v2.4.1",
      "extra": false,
      "extra_value": null,
      "created": "2024-01-15T10:30:00Z",
      "last_change": "2024-01-18T09:15:30Z"22Z",
      "pending": true
    }
  ]
}

Response Codes:

PUT /inventory_device_serial_setting/{parent__serial_number}/

Description: Performs a complete update of device settings for the specified device serial number. This endpoint replaces theall entireexisting configuration setsettings with the provided data, making it idealsuitable for bulk configuration updates or complete device reconfiguration scenarios.

Use Cases:

• Apply a complete new configuration templatestemplate to devicesa device
• Perform bulk configuration updates during device provisioning

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_setting/RTR001234/SN123456789/

Parameters:

cURL Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_serial_setting/RTR001234/SN123456789/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "settings"parameter": [ {
      "parameter_id"id": 45,
      "name": "WiFi Password",
      "variable_name": "wifi_password",
      "type": "password",
      "required": true,
      "read_only": false,
      "group": {
        "name": "Wireless Configuration"
      }
    },
    "value": "192.168.100.10"
      },
      {
        NewSecurePassword456!"parameter_id": 46,
        "value": "192.168.100.50-192.168.100.150"
      }
    ]
  }'

Example Response:

{
  "id": 1001,
  "parent_id": "RTR001234"SN123456789",
  "parent__name": "Router-Branch-Office-01"Router_Building_A",
  "parameter": {
    "id": 45,
    "name": "WANWiFi Interface IP Address"Password",
    "short_name": "wan-ip"wifi-pass",
    "variable_name": "wan_interface_ip"wifi_password",
    "type": "string"password",
    "position": 1,10,
    "required": true,
    "read_only": false,
    "metric": false,
    "group": {
      "id": 3,5,
      "name": "NetworkWireless Configuration",
      "service": "routing"WiFi Management",
      "discovery_group": "network",
      "title": "NetworkWiFi Settings"
    }
  },
  "value": "192.168.100.10"NewSecurePassword456!",
  "extra": false,
  "extra_value": null,
  "created": "2024-01-15T10:30:00Z",
  "last_change": "2024-01-22T11:45:20Z"22T16:20:15Z",
  "pending": true
}

Response Codes:

PATCH /inventory_device_serial_setting/{parent__serial_number}/

Description: Performs a partial update of device settings,settings allowingfor youthe tospecified modifydevice serial number. Unlike PUT, this endpoint only modifies the specific configurationfields parametersprovided withoutin affectingthe request, leaving other settings.settings unchanged. This endpoint is perfectideal for targeted configuration changes and incremental updates to device parameters.updates.

Use Cases:

• Update specifica single configuration parametersparameter without changingaffecting others
• Apply incrementalsecurity configurationpatches changesthat modify specific settings
• ModifyAdjust individualperformance settingsparameters based on monitoring alertsdata

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_serial_setting/RTR001234/SN123456789/

Parameters:

cURL Example:

curl -X PATCH "https://control.zequenze.com/api/v1/inventory_device_serial_setting/RTR001234/SN123456789/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parameter_id": 46,
    "value": "192.168.100.75-192.168.100.175"UpdatedValue123"
  }'

Example Response:

{
  "id": 1002,1001,
  "parent_id": "RTR001234"SN123456789",
  "parent__name": "Router-Branch-Office-01"Router_Building_A",
  "parameter": {
    "id": 46,45,
    "name": "DHCPWiFi Pool Range"Password",
    "short_name": "dhcp-range"wifi-pass",
    "variable_name": "dhcp_pool_range"wifi_password",
    "type": "string"password",
    "position": 2,10,
    "required": false,true,
    "read_only": false,
    "metric": false,
    "group": {
      "id": 3,5,
      "name": "NetworkWireless Configuration",
      "service": "dhcp"WiFi Management",
      "discovery_group": "network",
      "title": "NetworkWiFi Settings"
    }
  },
  "value": "192.168.100.75-192.168.100.175"UpdatedValue123",
  "extra": false,
  "extra_value": null,
  "created": "2024-01-15T10:30:00Z",
  "last_change": "2024-01-22T15:30:45Z"22T17:45:08Z",
  "pending": true
}

Response Codes:

Common Use Cases

Use Case 1: Device Configuration Audit

Retrieve all settings for multiple devices to generate configuration reports and ensureverify compliance with organizationalsecurity policies and configuration standards. Use the GET endpoint with variousdifferent filtersserial numbers and filter by parameter groups to identify devices withaudit specific configurationsconfiguration or pending changes.categories.

Use Case 2: Bulk DeviceWiFi ProvisioningPassword Update

When deployingupdating newWiFi credentials across a fleet of devices, use the PATCH endpoint to modify only the WiFi password parameter without affecting other network settings, minimizing the risk of configuration conflicts.

Use Case 3: Firmware Update Monitoring

Track firmware versions across devices using the GET endpoint with metric-enabled parameters. Filter by read-only parameters to monitor system information and identify devices that need updates.

Use Case 4: Factory Reset Recovery

After a factory reset, use the PUT endpoint to applyrestore a complete device configuration templates.from Thisa ensurespreviously saved backup, ensuring consistent device setup across similaryour device types and reduces manual configuration errors.network.

Use Case 3: Dynamic Configuration Management

Monitor device performance and automatically adjust specific parameters using the PATCH endpoint. For example, modify DHCP ranges, update QoS settings, or adjust security parameters based on network conditions.

Use Case 4:5: Pending Changes Management

Use the pending=true filter with the GET endpoint to identify all devices withMonitor configuration changes waiting to be applied.applied by using the GET endpoint with the pending=true parameter. This ishelps crucialtrack which devices have configuration updates queued for maintenance planning and change management workflows.

Use Case 5: Parameter-Specific Updates

Filter settings by parameter names or variable names to update specific configuration types across multiple devices. For example, update all WiFi passwords or modify firewall rules across your device fleet.deployment.

Best Practices

• PaginationSerial StrategyNumber Validation: Always verify that the device serial number exists before attempting configuration changes to avoid errors

Serial Number Validation: Ensure serial numbers are properly formatted and exist in your inventory before making update requests to avoid 404 errors.

Pending Changes Workflow: Check for pending changes before applying new configurations. Consider implementing a change approval process for critical device parameters.

Parameter Type Awareness: Understand parameter types (string, integer, boolean, etc.) and format values correctly. Invalid formats will result in validation errors.

Error Handling: Implement robust error handling for validation errors (422 responses,status ascodes) theseand indicateprovide parametermeaningful validation failures. Parse error messagesfeedback to identify specific validation issues.

Pending Status Monitoring: After making changes, monitor the pending status to ensure configurations are properly applied to devices

Security Considerations: Treat device serial numbers as sensitive identifiers. Implement proper access controls and audit logging for all configuration changes.

Batch Operations: For updating multiple parameters on the same device, prefer PUT operations over multiple PATCH requests to reduce API calls and improve consistency.