Inventory Device Name Variables

Endpoints Summary

Method Path Swagger GET /inventory_device_name_variables/ Swagger ↗ PUT /inventory_device_name_variables/{parent__name}/ Swagger ↗

---

The Inventory Device Name Variables API providesenables accessmanagement toof device configuration parametersvariables and settings withinin the Zequenze controlControl system.platform. These endpoints allow you to retrieve and update device-specific variablessettings byand device name,parameters, making it easy to manageconfigure configurationand parametersmonitor device variables across your device inventory programmatically.inventory.

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 Variables API enablesprovides comprehensive access to device configuration settings within your inventory management system. These endpoints are essential for:

Device Configuration Management: Retrieve and modify device-specific variables and parameters Bulk Settings Operations: Query multiple devices or parameters simultaneously using comma-separated lists Real-time Monitoring: Check for pending settings changes and force updates when needed Flexible Filtering: Use wildcard matching and various filter options to find specific configurations

This API category works with device settings that have configurable variables, allowing you to maintain consistent configurations across your device inventory. The endpoints support both read and write operations, enabling complete lifecycle management of device configurationvariables settingsfrom andinitial parameterssetup through aongoing device-centric approach. This API category is designed for scenarios where you need to:

Retrieve device settings by device name rather than device ID, making integration easier when you know device names but not internal IDs Manage configuration parameters including variable names, values, types, and metadata Monitor pending changes to device configurations before they are applied Bulk parameter operations using comma-separated lists for efficient data retrieval Track configuration history with date information and extra metadata

The endpoints work together to provide a complete device configuration management workflow. The GET endpoint allows you to query current device settings with flexible filtering options, while the PUT endpoint enables updates to device configurations. Both endpoints support advanced features like wildcard matching, forced updates, and detailed metadata retrieval.maintenance.

Key concepts include:to understand:

• Variable Names: Internal parameter identifiers used by the system for device parameters
• Parameter Names: Human-readable names for configurationdevice settings
• Short Names: Abbreviated parameter identifiers for compact displays
• Pending StatusSettings: IndicatesChanges whetherthat configurationhave changesbeen areconfigured waitingbut not yet applied to be applieddevices
• Extra Information: Additional metadata and extendedcontext parameterabout detailsparameters

---

Endpoints

GET /inventory_device_name_variables/

Description: Retrieves device configuration parametersvariables and settings filteredbased byon devicespecified name.filters. This endpoint is essential for querying current device configurations, checking parameter values, and monitoring pending changes,changes andacross extractingyour specific parameter sets. It supports flexible filtering by parameter names, variable names, or short names, with optional wildcard matching for pattern-based queries.inventory.

Use Cases:

• Retrieve all configuration parameters for a specificAudit device by name

Monitor devices with pending configuration changesconfigurations across your inventory Extract specific parameters (like network settings or thresholds) from multiple devices AuditMonitor pending setting changes before deployment Retrieve specific parameter values for reporting or validation Bulk export of device configurationssettings withfor historicalbackup dateor informationanalysis

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_name_variables/?parent__name=router-01&parameter__variable_name=network_config,snmp_communityhostname,ip_address&extra=true&dates=true

Parameters:

Parameter	Type	In	Required	Description
parent__name	string	query	Yes	Filter settings by device name. This identifiesIdentifies which device's parametersvariables to retrieve
parameter__variable_name	string	query	No	Comma-separated list of parameter variable names to retrieve (e.g., "network_ip,snmp_port"hostname,ip_address,vlan_id")
parameter__name	string	query	No	Comma-separated list of human-readable parameter names to retrievefilter by
parameter__short_name	string	query	No	Comma-separated list of parameter short names for compact identification
limit	integer	query	No	Number of results to return per page (default pagination limit applies)applies if not specified)
offset	integer	query	No	Starting index for paginated resultspagination (use with limit for pagination)page navigation)
pending	boolean	query	No	FilterWhen totrue, showreturns only parametersvariables with pending changes whenawaiting set to truedeployment
wildcard	boolean	query	No	Enable wildcard (*) matching in variable_name or parameter nameparameter_name fields
force_update	boolean	query	No	Force refresh ofForces device settings from the devicerefresh before returning data (may increase response time)
extra	boolean	query	No	Include additional metadata and extendedcontext information for each parameter information
dates	boolean	query	No	Include creation/modificationtimestamp timestampsinformation forshowing configurationwhen trackingparameters were last modified

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_variables/?parent__name=router-switch-core-01&parameter__variable_name=network_config,device_namemanagement_ip,snmp_community&extra=true&dates=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "count": 15,3,
  "next": "https://control.zequenze.com/api/v1/inventory_device_name_variables/?limit=10&offset=10&parent__name=router-01",null,
  "previous": null,
  "results": [
    {
      "id": 1247,1547,
      "name": "NetworkManagement Configuration"IP Address",
      "variable_name": "network_config"management_ip",
      "value": "192.168.1.100/24"100",
      "type": "ipv4_network"ipv4_address",
      "short_name": "net_cfg"mgmt_ip",
      "extra": true,false,
      "extra_value": "gateway=192.168.1.1,dns=8.8.8.8"Primary management interface",
      "pending": false
    },
    {
      "id": 1248,1548,
      "name": "DeviceSNMP Name"Community String",
      "variable_name": "device_name"snmp_community",
      "value": "router-01"public",
      "type": "string",
      "short_name": "snmp_comm",
      "extra": true,
      "extra_value": "Read-only community for monitoring",
      "pending": true
    },
    {
      "id": 1549,
      "name": "Device Location",
      "variable_name": "device_location",
      "value": "Data Center Rack 15",
      "type": "string",
      "short_name": "location",
      "extra": false,
      "extra_value": null,
      "pending": false
    },
    {
      "id": 1249,
      "name": "SNMP Community",
      "variable_name": "snmp_community",
      "value": "private_updated",
      "type": "string",
      "short_name": "snmp",
      "extra": false,
      "extra_value": null,
      "pending": true
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns device parametersvariables matching the specified criteria
400	Bad Request - MissingInvalid parameter values or missing required parent__name parameter or invalid query parameters
401	Unauthorized - Invalid or missing authentication token
404	Not Found - NoSpecified device foundname withdoes thenot specified nameexist

---

PUT /inventory_device_name_variables/{parent__name}/

Description: Updates device configuration parametersvariables for thea specifiedspecific device name.device. This endpoint allows you to modify device settings by sending parameter data in thebulk, requestapplying body.new Thevalues operationto updatesone existingor more parameters simultaneously. Changes may be applied immediately or creates new ones as needed, with changes typically marked as pending untildepending appliedon toyour thesystem actual device.configuration.

Use Cases:

• Update networkdevice configuration settings forafter anetwork specificchanges

deviceApply standardized configurations across similar devices Modify SNMPdevice parameters,parameters thresholds,for compliance or operationalsecurity settingsrequirements Bulk update multiple parametersvariables in a single API call Apply configuration templates to devices by name

Full URL Example:

https://control.zequenze.com/api/v1/inventory_device_name_variables/router-01/branch-05/

Parameters:

Parameter	Type	In	Required	Description
parent__name	string	path	Yes	The nameName of the device whose parametersvariables will be updated
data	string	body	Yes	JSON payload containing parameterthe variable updates withto variable names and new valuesapply

cURL Example:

curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_name_variables/router-01/switch-access-12/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "parameters"variable_name": ["management_ip",
    "value": "192.168.1.125"
  }'

Example Request Body:

{
  "variable_name": "snmp_community"management_ip",
  "value": "new_community_string"
      }192.168.1.125",
  {
        "variable_name"name": "poll_interval",Management "value":IP "300"Address"
}
    ]
  }'

Example Response:

{
  "id": 1249,1892,
  "name": "SNMPManagement Community"IP Address",
  "variable_name": "snmp_community"management_ip",
  "value": "new_community_string"192.168.1.125",
  "type": "string"ipv4_address",
  "short_name": "snmp"mgmt_ip",
  "extra": false,
  "extra_value": null,"Primary management interface",
  "pending": true
}

Response Codes:

Status	Description
200	Success - ParametersVariable updated successfully
400	Bad Request - Invalid parameterdata dataformat or malformedvariable request bodyname
401	Unauthorized - Invalid or missing authentication token
404	Not Found - Device withor specified namevariable does not exist
422	Unprocessable Entity - ParameterValid validationJSON failedbut invalid parameter values

---

Common Use Cases

Use Case 1: Device Configuration Audit

QueryRetrieve all parametersconfiguration variables for specific devices to perform configuration audits orrequiring compliance checks.verification. Use the extraGET endpoint with extra=true and dates parametersdates=true to get complete configuration history.history and metadata for audit trails.

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_variables/?parent__name=critical-router&extra=true&dates=true"

Use Case 2: Bulk NetworkIP ConfigurationAddress UpdatesManagement

Update network settings across multipleQuery devices by iteratingIP-related through devicevariable names andusing applyingwildcard consistentmatching configuration(wildcard=true parameters.with parameter__variable_name=*ip*) to inventory all IP assignments across your network infrastructure.

Use Case 3: Pending Changes MonitoringReview

Monitor configuration changes awaiting deployment by using pending=true parameter to identify devices with pendingstaged configurationbut changesnot toyet trackapplied deploymentsettings, statusensuring andproper ensurechange changesmanagement are properly applied.workflows.

curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name_variables/?parent__name=router-01&pending=true"

Use Case 4: ParameterStandardized PatternDevice MatchingProvisioning

UseUpdate wildcardmultiple filteringconfiguration parameters for new devices using the PUT endpoint to findapply all parameters matching organization-specific patterns, useful for discovering related configuration settings acrosslike devices.SNMP communities, NTP servers, and management credentials.

Use Case 5: Emergency Configuration Template DeploymentUpdates

ApplyForce standardizedreal-time configuration templatesrefresh using force_update=true during network incidents to devicesensure byyou're updatingworking multiple parameters simultaneously throughwith the PUTmost endpoint.current device state before making critical changes.

---

Best Practices

• Use Pagination Effectively: For large inventories, implement proper pagination using limit and offset parameters to avoid timeouts and improve performance

Filter Strategically: Always use the most specific filters possible (device namesnames, consistentlyspecific variable names) to reduce response times and network overhead Handle Pending Changes: -Check Ensurefor devicepending namessettings before making updates to avoid conflicts. Consider the impact of forcing updates in yourproduction API calls match exactly with those stored in the system, as the parent__name parameter is case-sensitiveenvironments Implement properError paginationHandling: -Wrap ForAPI devices with many parameters, use limit and offset parameters to handle large result sets efficiently Monitor pending status - Always check the pending fieldcalls in responsesproper toerror understandhandling, which changes haven't been applied to physical devices yet Leverage wildcard filtering - Use the wildcard parameter when searchingespecially for parameterPUT patterns,operations butthat bemodify cautiousdevice of performance impact on large datasetsconfigurations Cache configurationWhen dataAppropriate: -For Devicefrequently parametersaccessed typicallybut don'trarely changechanging frequently, sodata, implement appropriateclient-side caching strategieswith toappropriate reduceTTL API callsvalues HandleSecurity force_updateConsiderations: carefullyTreat configuration data as sensitive - The force_update parameter triggers real device communication, which may be slow; use sparinglyHTTPS, rotate API tokens regularly, and implement appropriateproper timeoutsaccess logging ValidateBatch parameterOperations: typesWhen -updating Checkmultiple variables for the typesame fielddevice, incombine responsesthem tointo ensure you're sending appropriately formatted values insingle PUT requests rather Usethan specificmaking parametermultiple filtersindividual - Instead of retrieving all parameters, use parameter__variable_name or parameter__name filters to get only needed data Implement retry logic - Network devices may be temporarily unreachable; implement exponential backoff for failed requestscalls

---