Skip to main content

Inventory Device Setting

Endpoints Summary

Method Path Swagger GET /inventory_device_setting/ Swagger ↗ PUT /inventory_device_setting/{parent_id}/ Swagger ↗ PATCH /inventory_device_setting/{parent_id}/ Swagger ↗

The Inventory Device Setting API endpoints allowprovide comprehensive management of device configuration parameters and settings within the Zequenze Control platform. These endpoints enable you to retrieve, update, and managemodify configurationdevice-specific parameterssettings including network configurations, operational parameters, and device behavior controls for managed devices in your inventory. These endpoints are essential for monitoring device configurations, updating settings, and tracking parameter changes across your managed devices.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Device Setting API providescategory comprehensive management of devicemanages configuration parameters withinand thesettings Zequenzefor platform.devices in your inventory system. These endpoints enableallow you to:

  • Retrieve device settings - QueryGet current configuration parameters for specific devices or groupsfilter ofby devicesparameter types
  • Update device configurations - Modify device settings through fullindividually or partialin updatesbulk
  • Track setting changes - Monitor settingpending modifications with timestampschanges and pendingconfiguration status indicatorshistory
  • FilterManage parametersparameter types - SearchHandle settingsdifferent bydata parametertypes names,including variablestrings, names,integers, orbooleans, devicedates, relationshipsand complex objects

Device settings in the Zequenze representplatform configurableare organized around parameters that candefine behow applieddevices tobehave managedand devices.operate. Each setting includes metadata about theits parameter type, whether it's required, read-only status, and ifwhether it should be tracked as a metric.metric Thefor systemhistorical maintains a history of changes and indicates when settings are pending application to the actual device.analysis.

Common use casesscenarios include bulkconfiguring configurationnetwork updates,settings compliancefor monitoring,CPE parameterdevices, validationupdating beforefirmware deployment,parameters, managing security settings, and automatedmonitoring operational metrics across your device provisioning workflows.fleet.

Endpoints

GET /inventory_device_setting/

Description: Retrieves a paginated list of device settings filteredbased byon various filter criteria. This endpoint is primarily used to query configuration parameters for specific devices or to search for settings based on parameter characteristics. It's essential for configurationdiscovering audits,current bulkdevice operationsconfigurations, preparation,monitoring setting states, and monitoringbuilding device parametermanagement states.dashboards.

Use Cases:

  • RetrieveView all configuration parameterssettings for a specific device beforeusing makingthe changesparent_id filter
  • Search forFind settings by parameter name or variable name across multiple devices
  • Monitor pending configuration changes that haven't been applied yet
  • GenerateBuild device configuration reports forand compliance auditingdashboards

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_setting/?parent_id=123&parameter__name=wifi_ssidpending=false&limit=50&offset=0

Parameters:

Parameter Type In Required Description
parent_id integer query Yes TheFilter settings by device ID to(parent filterID settings for. This identifies which device's settings you want to retrievefield)
parameter_id string query No Filter by specific parameter ID if you need settings for a particular parameter type
parameter__variable_name string query No Filter by parameter variable name (e.g., "wifi_password"wifi_ssid", "admin_user"dhcp_enabled")
parameter__name string query No Filter by human-readable parameter name (e.g., "WiFi Password", "Administrator Username")
parameter__short_name string query No Filter by parameter short name or slug identifier
limit integer query No Number of results per page (default:default 20, max: 100)varies)
offset integer query No Starting index for pagination (default: 0)
pending boolean query No FilterShow foronly settings that arewith pending application to the devicechanges (true/false)

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_setting/?parent_id=123&parameter__variable_name=wifi_ssid&pending=true"limit=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 25,45,
  "next": "https://control.zequenze.com/api/v1/inventory_device_setting/?limit=2025&offset=2025&parent_id=123",
  "previous": null,
  "results": [
    {
      "id": 1547,1001,
      "parent_id": "123",
      "parent__name": "Router-Branch-Office-Router-01",
      "parameter": {
        "id": 45,15,
        "name": "WiFi SSID"Network Name",
        "short_name": "wifi-ssid",
        "variable_name": "wifi_ssid",
        "type": "string",
        "position": 1,
        "required": true,
        "read_only": false,
        "metric": false,
        "group": {
          "id": 12,3,
          "name": "Wireless Configuration"Settings",
          "service": "WiFi Management",
          "discovery_group": "Network"wifi",
          "title": "WiFi Settings"Configuration"
        }
      },
      "value": "CompanyGuest"CompanyWiFi_Guest",
      "extra": false,
      "extra_value": null,
      "created": "2024-01-15T10:30:00Z",
      "last_change": "2024-01-20T14:25:22:00Z",
      "pending": false
    },
    {
      "id": 1548,1002,
      "parent_id": "123",
      "parent__name": "Router-Branch-Office-Router-01",
      "parameter": {
        "id": 46,16,
        "name": "WiFiDHCP Password"Enabled",
        "short_name": "wifi-password"dhcp-enabled",
        "variable_name": "wifi_password"dhcp_enabled",
        "type": "password"boolean",
        "position": 2,
        "required": true,
        "read_only": false,
        "metric": false,true,
        "group": {
          "id": 12,4,
          "name": "WirelessNetwork Configuration"Settings",
          "service": "WiFi Management",
          "discovery_group": "Network"network",
          "title": "WiFiNetwork Settings"Configuration"
        }
      },
      "value": "********true",
      ",extra": false,
      "extra_value": null,
      "created": "2024-01-15T10:30:00Z",
      "last_change": "2024-01-22T09:18T09:15:00Z",
      "pending": true
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginated list of device settings
400 Bad Request - MissingInvalid requiredquery parent_id parameterparameters
401 Unauthorized - Invalid or missing API token
403 Forbidden - Insufficient permissions to viewaccess device settings
404 Not Found - Device with specified parent_id does not exist

PUT /inventory_device_setting/{parent_id}/

Description: Performs a complete update of all device settings for thea specifiedspecific device.device (parent_id). This endpoint replaces all current settings with the providedentire data,configuration set, making it ideal for bulk configuration updates or when you need to ensure aand device hasprovisioning exactly the configuration you specify. Use this when you want to set the complete configuration state of a device.scenarios.

Use Cases:

  • DeployComplete adevice completereconfiguration during maintenance windows
Bulk provisioning of new devices with standard configuration template to a new devicetemplates RestoreRestoring device settings from abackup known good backupconfigurations StandardizeApplying organization-wide policy changes to device configurations across a fleet Reset device configuration to factory defaults with custom valuesfleets

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_setting/123/

Parameters:

Parameter Type In Required Description
parent_id integer path Yes The deviceDevice ID whosefor settings you wantwhich to update completelyall settings
data object body Yes Complete device configuration data includingcontaining all parameterdevice valuessettings

cURL Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_setting/123/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "settings": [
      {
        "parameter_id": 45,15,
        "value": "NewCompanyWiFi"
      },
      {
        "parameter_id": 46,16,
        "value": "SecurePassword123!"true"
      },
      {
        "parameter_id": 47,17,
        "value": "192.168.1.1"
      }
    ]
  }'

Example Response:

{
  "id": 1547,1001,
  "parent_id": "123",
  "parent__name": "Router-Branch-Office-Router-01",
  "parameter": {
    "id": 45,15,
    "name": "WiFi SSID"Network Name",
    "short_name": "wifi-ssid",
    "variable_name": "wifi_ssid",
    "type": "string",
    "position": 1,
    "required": true,
    "read_only": false,
    "metric": false,
    "group": {
      "id": 12,3,
      "name": "Wireless Configuration"Settings",
      "service": "WiFi Management"wifi",
      "discovery_group": "Network"wireless",
      "title": "WiFi Settings"Configuration"
    }
  },
  "value": "NewCompanyWiFi",
  "extra": false,
  "extra_value": null,
  "created": "2024-01-15T10:30:00Z",
  "last_change": "2024-01-25T11:22T16:45:00Z",
  "pending": true
}

Response Codes:

Status Description
200 Success - Device settings updated successfully
400 Bad Request - Invalid configuration data format or missingparameter required parametersvalues
401 Unauthorized - Invalid or missing API token
403 Forbidden - Insufficient permissions to modify device settings
404 Not Found - Device with specified parent_id does not exist
422 Unprocessable Entity - Validation errors in parameter values

PATCH /inventory_device_setting/{parent_id}/

Description: Performs a partial updateupdates ofto device settings,settings allowingfor a specific device. Unlike PUT, this endpoint allows you to modify only specific parameterssettings without affecting other existing settings. This endpoint is ideal for targeted configuration changes, such as updating a single parameter or a small subset of settings while preserving the rest of the device configuration.configuration, making it perfect for targeted configuration changes.

Use Cases:

  • Update a specificindividual configuration parameterparameters (e.g.,without changeaffecting WiFi password only)others
  • Apply security updatespatches that affectmodify only certainspecific settings
Adjust operational parameters based on monitoring data Make incremental configuration adjustmentschanges Updateduring device settings based on monitoring alerts or policy changestroubleshooting

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_setting/123/

Parameters:

Parameter Type In Required Description
parent_id integer path Yes The deviceDevice ID whosefor settings you wantwhich to partiallyupdate updatespecific settings
data object body Yes Partial device configuration data withcontaining only the parameters you wantsettings to modify

cURL Example:

curl -X PATCH "https://control.zequenze.com/api/v1/inventory_device_setting/123/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parameter_id": 46,16,
    "value": "NewSecurePassword456!"false"
  }'

Example Response:

{
  "id": 1548,1002,
  "parent_id": "123",
  "parent__name": "Router-Branch-Office-Router-01",
  "parameter": {
    "id": 46,16,
    "name": "WiFiDHCP Password"Enabled",
    "short_name": "wifi-password"dhcp-enabled",
    "variable_name": "wifi_password"dhcp_enabled",
    "type": "password"boolean",
    "position": 2,
    "required": true,
    "read_only": false,
    "metric": false,true,
    "group": {
      "id": 12,4,
      "name": "WirelessNetwork Configuration"Settings",
      "service": "WiFi Management"network",
      "discovery_group": "Network"network",
      "title": "WiFiNetwork Settings"Configuration"
    }
  },
  "value": "********false",
  ",extra": false,
  "extra_value": null,
  "created": "2024-01-15T10:30:00Z",
  "last_change": "2024-01-25T16:22T17:20:00Z",
  "pending": true
}

Response Codes:

Status Description
200 Success - DeviceSpecific settingdevice settings updated successfully
400 Bad Request - Invalid parameter data format or parametervalues
401 Unauthorized - Invalid or missing API token
403 Forbidden - Insufficient permissions to modify device settings
404 Not Found - Device or parameter does not exist
422 Unprocessable Entity - Validation error for the parameter value

Common Use Cases

Use Case 1: Device Configuration AuditDashboard

RetrieveBuild a comprehensive device management dashboard by first retrieving all settings for amultiple devicedevices, then use the parameter filtering to performorganize compliancesettings checkingby orgroups generate(WiFi, configurationNetwork, reports.Security). Use the GET endpoint with filteringdifferent toparent_id examinevalues specificand parameter groups or identify pending changes before they're applied.filters.

Use Case 2: Bulk WiFi PasswordConfiguration Update

UpdateWhen updating WiFi passwordscredentials across multiple devicesbranch inoffice your network. First,routers, use GET to identify devices with WiFi parameters, then usethe PATCH endpoint to update only the passwordWiFi-related parameterparameters while(SSID, preservingpassword, security type) without affecting other wirelessnetwork settings.

Use Case 3: New Device Provisioning

DeployFor new device deployments, use the PUT endpoint to apply a complete configuration template to newly added devices. Use PUT to apply a standardized configuration that includes all required parameters for the device type, ensuring consistent setup across your organization's network policies.infrastructure.

Use Case 4: Monitoring Configuration DriftChange Monitoring

RegularlyMonitor querypending changes across your device settings to detect unauthorized changes or configuration drift. Filterfleet by parameter types and useusing the pendingGET flagendpoint with pending=true to identify settings that haven't been synchronizeddevices with theconfiguration physicalchanges device.waiting to be applied, enabling proactive change management.

Use Case 5: EmergencyCompliance Security UpdatesReporting

QuicklyGenerate updatecompliance security-reports by filtering settings using parameter names related parametersto security configurations (firewall settings, encryption parameters, access controls) across yourall devicemanaged fleet. Use PATCH to modify specific security settings (like admin passwords or access control parameters) without disrupting other operational configurations.devices.

Best Practices

  • Use pagination wiselyeffectively: - When queryingretrieving largesettings devicefor inventories,multiple alwaysdevices, useimplement proper pagination with appropriate limit values (recommended: 50-25-100) to avoid timeouts and improve response times.performance.

  • MonitorHandle pending statuschanges carefully: - Always check the pending field in responses to understand whichif settingschanges have been applied to devices. Implement polling or webhooks to track when pending changes are queued for application. Schedule follow-up checks to ensure configurations are successfully applied.processed.

  • Filter effectively: Use parameter-based filters to reduce response sizes and improve query performance. Combine parent_id with specific parameter filters for targeted operations.

HandleValidate parameter types correctly:- RespectBefore updating settings, ensure values match the expected parameter type definitions(string, wheninteger, updatingboolean, values.etc.) Booleanas parametersdefined expectin true/false,the integersparameter requireobject numericto values, and password fields may have specialavoid validation rules.errors.

Implement retryproper logicerror handling: - Device configurationsettings updates maycan fail due to networkdevice connectivity issues or deviceinvalid unavailability.configurations. ImplementAlways exponentialhandle backoff400/403/404 retryerrors logicgracefully forand criticalprovide configurationmeaningful changes.feedback.

Validate before bulk operations: Use GETpartial requestsupdates wisely - Prefer PATCH over PUT for single parameter changes to validatereduce currentthe devicerisk statesof unintended configuration changes and parameterimprove requirementsupdate before performing bulk updates with PUT or PATCH.performance.

TrackCache changesparameter withmetadata timestamps:- UseStore theparameter createddefinitions (types, constraints, groups) locally to reduce API calls and last_changeenable fieldsclient-side tovalidation implementbefore changesending tracking and audit trails for compliance requirements.updates.

SecureMonitor sensitivemetric parameters: Be- especiallyParameters carefulmarked with passwordmetric: true store historical data. Use these for trending and security-relatedalerting parameters.on Ensureimportant your application properly handles masked values in responses and validates input for securityoperational parameters.

Back to top