Skip to main content

Inventory Device Name

The Inventory Device Nameinventory_device_name API providesendpoints endpointsprovide comprehensive device management capabilities for managing network device inventory through name-based operations.systems. These endpoints enable fullyou to perform complete CRUD functionalityoperations foron network devices, including retrieving device management,lists statuswith monitoring,advanced filtering, creating new device entries, updating device configurations, and organizationalmanaging filtering,device makinglifecycle itoperations easylike toreboots maintainand anfactory up-to-date inventory of your network infrastructure.resets.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Device Nameinventory_device_name API category is designed for comprehensivemanaging network devices within an organization's infrastructure. These endpoints serve as the core interface for device inventory managementmanagement, within network infrastructure systems. This API allowsallowing you to perform complete lifecycle management of network devices, from initial registration to ongoing monitoring and maintenance.

Key Features:to:

  • DeviceTrack Discoverydevice inventory across multiple organizations and Registration: Add new devices to your inventory with detailed specificationslocations
  • Status Monitoring: TrackMonitor device operational status and historicalhealth changeswith real-time updates
  • OrganizationalManage Management:device configurations Filterincluding firmware updates and organizesettings devices by organizational unitssynchronization
  • Real-time Updates: Get currentControl device statusoperations withsuch optionalas livereboots, statusfactory checksresets, and configuration reapplication
  • Pending Configuration Tracking: Monitor devices that have configuration changes awaiting application

Common Integration Scenarios:

    Network monitoring dashboards pulling device statusFilter and inventory data Automated device provisioning systems registering new hardware Maintenance scheduling systems filteringsearch devices byusing typemultiple criteria like type, status, organization, and organization Compliance reporting tools tracking device status changes over timelocation

    The endpointsAPI worksupports togetherboth to provide a completeindividual device managementoperations workflow:(by listname) and filterbulk devices,operations retrieveacross detaileddevice information,collections. updateEach configurations,device is uniquely identified by its name and removecontains decommissionedcomprehensive equipment.metadata including hardware/software versions, serial numbers, location data, and operational status.

    Key concepts include device types (configuration templates), organizations (for multi-tenant environments), firmware management, and various operational states that control device behavior and connectivity.

    Endpoints

    GET /inventory_device_name/

    Description: Retrieves a paginated list of all devices in your inventory devices with comprehensive filtering options.capabilities. This endpoint servesis as the primary entry pointessential for device discoverydiscovery, monitoring dashboards, and bulk operations,operations. allowingIt yousupports toreal-time filterstatus by device characteristics, organizational boundaries,updates and operationalcan status.report pending configuration changes.

    Use Cases:

    • DashboardBuilding displaysdevice showingmonitoring alldashboards
    Filtering devices inby anstatus organizationfor maintenance operations Automated monitoring systems checking for devices with pending configurations Maintenance workflows identifyingFinding devices that haven'tneed beenfirmware updated recentlyupdates ComplianceGenerating auditsinventory filteringreports devicesfor byspecific typeorganizations andor statuslocations

    Full URL Example:

    https://control.zequenze.com/api/v1/inventory_device_name/?organization=5123&status=true&limit=50&offset=0

    Parameters:

    Parameter Type In Required Description
    type integer query No Filter devices by device type ID (e.g.,configuration router, switch, firewall)template)
    status string query No Filter by operationaldevice status. Use '0', /'false', /'False' for Down devices, or '1', /'true', /'True' for Up devices
    last_status_change_from string query No Filter devices withby status changeschange afterdate specified datetime in (ISO format (2000-01-01,format: 2000-01-01 00:01:00,or 2000-01-01 00:01:00+00:00)
    organization integer query No Filter devices by organization ID tofor scopemulti-tenant results to specific organizational unitsenvironments
    limit integer query No Number of results to return per page (default:default 20,pagination max: 100)applies)
    offset integer query No Starting index for pagination (use with limit for page navigation)
    pending boolean query No When true, includesInclude information about pending configuration changessettings
    update_status boolean query No When true, performsForce real-time status checkupdate before returning results (may increase response time)

    cURL Example:

    curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name/?organization=5123&status=true&limit=20&pending=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

    Example Response:

    {
  "count": 156,150,
  "next": "https://control.zequenze.com/api/v1/inventory_device_name/?limit=20&offset=20&organization=5&status=true"20",
  "previous": null,
  "results": [
    {
      "id": 1,
      "uuid": "550e8400-e29b-41d4-a716-446655440000",
      "name": "core-switch-01"router-hq-001",
      "customer_id": "CUST-001",
      "is_active": true,
      "status": "Up",
      "status_change": "2024-01-15T10:30:00Z",
      "type": 2,5,
      "type_name"type_short_name": "Core Switch"enterprise-router",
      "organization": 5,
      "organization_name"software_version": "IT Operations"1.4.2",
      "status": true,
      "ip_address"hardware_version": "192.168.1.10"Rev-C",
      "manufacturer": "Cisco",
      "serial_number": "CS-2024-001"SN123456789",
      "model"description": "CiscoMain Catalystheadquarters 9500"router",
      "last_seen"organization_id": 123,
      "location_name": "Headquarters - Server Room",
      "location_short_name": "HQ-SR",
      "latitude": "40.7128",
      "longitude": "-74.0060",
      "address": "192.168.1.1",
      "last_connection": "2024-01-15T14:30:22Z"22:00Z",
      "last_status_change"last_configuration": "2024-01-10T09:14T09:15:00Z",
      "pending_changes": true,
      "location"pending_settings": "Data Center Rack 4A",
      "firmware_version": "16.12.05"
    },
    {
      "name": "edge-router-02",
      "type": 1,
      "type_name": "Edge Router",
      "organization": 5,
      "organization_name": "IT Operations",
      "status": true,
      "ip_address": "10.0.1.1",
      "serial_number": "ER-2024-002",
      "model": "Juniper MX204",
      "last_seen": "2024-01-15T14:29:45Z",
      "last_status_change": "2024-01-12T16:20:30Z",
      "pending_changes": false,
      "location": "Network Closet B",
      "firmware_version": "21.2R3.8"firmware_update,reboot_pending"
    }
  ]
}

    Response Codes:

    Status Description
    200 Success - Returns paginated device list of devices
    401 Unauthorized - Invalid or missing authenticationAPI token
    403 Forbidden - Insufficient permissions tofor accessrequested organization devices
    400 Bad Request - Invalid filter parameters or date format

    POST /inventory_device_name/

    Description: Creates a new device entry in the inventory system. This endpoint is typically used duringwhen onboarding new network devices or registering devices that will connect via CWMP/TR-069 protocols. The device onboarding,name networkmust expansion,be orunique when integrating with automated discovery tools that identify new hardware onwithin the network.system.

    Use Cases:

    • AutomatedOnboarding new network discovery tools registering newly detected devicesequipment
    • ManualPre-registering devicedevices registrationbefore duringphysical infrastructure deploymentsinstallation
    • Bulk importdevice operationsprovisioning fromfor existingnew inventory systemssites
    • IntegrationSetting withup procurementdevice systemsauthentication when new hardware arrivescredentials

    Full URL Example:

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

    cURL Example:

    curl -X POST "https://control.zequenze.com/api/v1/inventory_device_name/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "new-firewall-03"router-branch-005",
    "customer_id": "CUST-005",
    "is_active": true,
    "type": 3,
    "organization": 5,
    "ip_address": "192.168.1.50",
    "serial_number": "FW-2024-003"SN987654321",
    "model": "Fortinet FortiGate 200F",
    "location": "DMZ Rack 1B",
    "firmware_version": "7.2.3",
    "status": false
  }'

    Example Request Body:

    {
  "name": "new-firewall-03",
  "type": 3,
  "organization": 5,
  "ip_address": "192.168.1.50",
  "serial_number": "FW-2024-003",
  "model": "Fortinet FortiGate 200F",
  "location": "DMZ Rack 1B",
  "firmware_version": "7.2.3",
  "status": false,
    "description": "EdgeBranch firewalloffice forrouter DMZ- protection"Site 005",
    "purchase_date"organization_id": 123,
    "location_name": "2024-01-10"Branch Office 005",
    "warranty_expiry"latitude": "2027-01-10"42.3601",
    "longitude": "-71.0589",
    "username": "device_005",
    "password": "secure_password_123"
  }'

    Example Response:

    {
  "id": 156,
  "uuid": "660f9511-f3ac-52e5-b827-557766551111",
  "name": "new-firewall-03"router-branch-005",
  "customer_id": "CUST-005",
  "is_active": true,
  "status": "Down",
  "status_change": "2024-01-15T15:45:00Z",
  "type": 3,5,
  "type_name"type_short_name": "Firewall",
  "organization": 5,
  "organization_name": "IT Operations",
  "ip_address": "192.168.1.50"enterprise-router",
  "serial_number": "FW-2024-003"SN987654321",
  "model": "Fortinet FortiGate 200F",
  "location": "DMZ Rack 1B",
  "firmware_version": "7.2.3",
  "status": false,
  "description": "EdgeBranch firewalloffice forrouter DMZ- protection"Site 005",
  "purchase_date"organization_id": 123,
  "location_name": "Branch Office 005",
  "latitude": "42.3601",
  "longitude": "-71.0589",
  "username": "device_005",
  "created": "2024-01-10",
  "warranty_expiry": "2027-01-10",
  "created_at": "2024-01-15T14:35:15T15:45:00Z",
  "updated_at"pending_settings": "2024-01-15T14:35:00Z",
  "pending_changes": falsenull
}

    Response Codes:

    Status Description
    201 Created - Device successfully added to inventorycreated
    400 Bad Request - Invalid data format or missingduplicate requireddevice fieldsname
    401 Unauthorized - Invalid or missing authenticationAPI token
    409 Conflict - Device name or serial number already exists

    GET /inventory_device_name/{name}/

    Description: Retrieves detailed information forabout a specific device identified by its unique name. This endpoint provides comprehensivecomplete device detailsmetadata, current status, and isconfiguration commonlydetails. usedIt's essential for device-specific operations, monitoring dashboards,operations and detailed configuration management.monitoring.

    Use Cases:

    • DeviceGetting detailcomplete pagesdevice indetails for management interfaces
    • Configuration management systems retrieving currentChecking device statestatus before performing operations
    Retrieving device credentials for configuration tasks Monitoring alerts requiring specific device informationhealth Troubleshootingand workflows needing complete device contextconnectivity

    Full URL Example:

    https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/?pending=true&update_status=true

    Parameters:

    Parameter Type In Required Description
    name string path Yes The uniqueUnique device name identifier
    pending boolean query No Include detailedpending settings information aboutin pending configuration changesresponse
    update_status boolean query No PerformForce real-time status check before returning device informationdata

    cURL Example:

    curl -X GET "https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/?pending=true&update_status=true" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

    Example Response:

    {
  "id": 1,
  "uuid": "550e8400-e29b-41d4-a716-446655440000",
  "name": "core-switch-01"router-hq-001",
  "customer_id": "CUST-001",
  "is_active": true,
  "status": "Up",
  "status_change": "2024-01-15T10:30:00Z",
  "type": 2,5,
  "type_name"type_short_name": "Core Switch"enterprise-router",
  "organization": 5,
  "organization_name"software_version": "IT Operations"1.4.2",
  "status": true,
  "ip_address"hardware_version": "192.168.1.10"Rev-C",
  "manufacturer": "Cisco",
  "unique_identifier": "cisco-1841-router",
  "product_class": "Router",
  "serial_number": "CS-2024-001"SN123456789",
  "model"serial_number_alt": "Cisco Catalyst 9500",
  "location": "Data Center Rack 4A",
  "firmware_version": "16.12.05"ALT-SN-001",
  "description": "PrimaryMain coreheadquarters switch for data center traffic"router",
  "purchase_date"organization_id": 123,
  "firmware_image": 15,
  "firmware_image_is_pending": true,
  "location_name": "2023-06-15"Headquarters - Server Room",
  "warranty_expiry"location": 45,
  "location_short_name": "2026-06-15"HQ-SR",
  "last_seen"latitude": "40.7128",
  "longitude": "-74.0060",
  "username": "admin_hq_001",
  "update_frequency": 300,
  "address": "192.168.1.1",
  "last_connection": "2024-01-15T14:30:22Z"22:00Z",
  "last_status_change"last_configuration": "2024-01-10T09:14T09:15:00Z",
  "created_at"last_change": "2023-06-20T10:2024-01-14T09:15:00Z",
  "created": "2024-01-01T08:00:00Z",
  "updated_at"debug": false,
  "pending_settings": "2024-01-15T14:30:22Z",
  "pending_changes": true,
  "pending_details": {
    "config_changes": 3,
    "firmware_update": true,
    "last_config_push": "2024-01-14T16:45:00Z"
  },
  "interfaces": [
    {
      "name": "GigabitEthernet1/0/1",
      "status": "up",
      "speed": "1000Mbps"
    }
  ],
  "uptime": "15 days, 8 hours, 22 minutes"firmware_update,configuration_sync"
}

    Response Codes:

    Status Description
    200 Success - Returns detailedcomplete device information
    401 Unauthorized - Invalid or missing authenticationAPI token
    404 Not Found - Device with specified name does not exist
    403 Forbidden - Insufficient permissions to access this device

    PUT /inventory_device_name/{name}/

    Description: CompletelyPerforms replacesa complete update of a device's configuration, replacing all devicemodifiable informationfields with the provided data. This endpoint performsis aused fullfor update operation, requiring allcomprehensive device fieldsreconfiguration, toincluding be specified. Use this when you need to update multiplechanging device attributesprofiles, orlocations, whencredentials, integratingand withoperational systems that provide complete device records.settings.

    Use Cases:

    • Bulk synchronization from external inventory management systems
    Complete device reconfiguration during infrastructure changesmigrations Data migration scenarios requiring full record replacement Integration with asset management systems providing completeUpdating device profiles and types Changing device location and organizational assignment Bulk configuration updates via automation scripts

    Full URL Example:

    https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/

    cURL Example:

    curl -X PUT "https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "core-switch-01"router-hq-001",
    "customer_id": "CUST-001-UPDATED",
    "is_active": true,
    "type": 2,
    "organization": 5,
    "ip_address": "192.168.1.10",7,
    "serial_number": "CS-2024-001"SN123456789",
    "model": "Cisco Catalyst 9500",
    "location": "Data Center Rack 4A",
    "firmware_version": "16.12.06",
    "status": true,
    "description": "Updated primaryheadquarters coremain switch with latest firmware"router",
    "purchase_date"organization_id": 123,
    "location_name": "2023-06-15"Headquarters - New Server Room",
    "warranty_expiry"latitude": "2026-06-15"40.7128",
    "longitude": "-74.0060",
    "username": "admin_hq_001_new",
    "password": "updated_secure_password",
    "update_frequency": 600,
    "debug": true,
    "sync": true
  }'

    Response Codes:

    Status Description
    200 Success - Device informationconfiguration updated completely updated
    400 Bad Request - Invalid data format or missingvalidation required fieldserrors
    401 Unauthorized - Invalid or missing authenticationAPI token
    404 Not Found - Device with specified name does not exist

    PATCH /inventory_device_name/{name}/

    Description: Performs a partial update of devicea information,device's configuration, modifying only the specified fields while leaving other attributesothers unchanged. This endpoint is ideal for targeted updates like statuschanging changes,device firmwarestatus, updates,triggering operations, or locationupdating modificationsspecific withoutconfiguration affecting other device data.parameters.

    Use Cases:

    • Status updates from monitoring systems detectingTriggering device stateoperations changes(reboot, factory reset, sync)
    • LocationUpdating updatesspecific whenconfiguration devicesfields arewithout physicallyfull relocatedreconfiguration
    • FirmwareEnabling/disabling versiondebug tracking after upgrade operationsmode
    • IncrementalChanging datafirmware updatesupdate from automated discovery toolssettings

    Full URL Example:

    https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/

    cURL Example:

    curl -X PATCH "https://control.zequenze.com/api/v1/inventory_device_name/core-switch-01/router-hq-001/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "firmware_version"description": "16.12.06"Updated device description",
    "status"debug": true,
    "location"reboot": true,
    "Datafirmware_image": Center18,
    Rack"firmware_image_is_pending": 4B"true
  }'

    ExampleDevice RequestOperation Body:Examples:

    Reboot Device:

    {curl -X PATCH "firmware_version"https://control.zequenze.com/api/v1/inventory_device_name/router-hq-001/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"reboot": "16.12.06",true}'

    Factory Reset:

    curl -X PATCH "status"https://control.zequenze.com/api/v1/inventory_device_name/router-hq-001/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"factory": true,true}'

    Sync Configuration:

    curl -X PATCH "location"https://control.zequenze.com/api/v1/inventory_device_name/router-hq-001/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"sync": "Data Center Rack 4B",
  "description": "Relocated and updated with latest firmware"
}true}'

    Response Codes:

    Status Description
    200 Success - Device information partially updated
    400 Bad Request - Invalid datafield formatvalues foror providedoperation fieldsconflicts
    401 Unauthorized - Invalid or missing authenticationAPI token
    404 Not Found - Device with specified name does not exist

    DELETE /inventory_device_name/{name}/

    Description: Permanently removes a device from the inventory system. This endpoint should be used when devices are decommissioned, replaced, or no longer part of the managed infrastructure. The operation is irreversible and will removedelete all associated device data.data, configuration history, and relationships. Use with caution, especially in production environments.

    Use Cases:

    • Decommissioning oldretired hardwarenetwork that's been replacedequipment
    • Removing test devices thatfrom areproduction no longer part of the managed networkinventory
    • CleanupCleaning up duplicate or incorrectly created device entries
    Mass cleanup operations forduring devicessystem that were incorrectly added Automated removal of devices that haven't been seen for extended periodsmigrations

    Full URL Example:

    https://control.zequenze.com/api/v1/inventory_device_name/old-router-05/decommissioned/

    cURL Example:

    curl -X DELETE "https://control.zequenze.com/api/v1/inventory_device_name/old-router-05/decommissioned/" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

    Response Codes:

    Status Description
    204 No Content - Device successfully deleted from inventory
    401 Unauthorized - Invalid or missing authenticationAPI token
    404 Not Found - Device with specified name does not exist
    403409 ForbiddenConflict - InsufficientDevice permissionscannot be deleted due to delete this devicedependencies

    Common Use Cases

    Use Case 1: NetworkDevice Status Monitoring Dashboard Integration

    BuildMonitor adevice real-timehealth across your network monitoring dashboard by firstregularly callingpolling the GET GET /inventory_device_name/ endpoint with update_status=true toand get current device states, then use GET /inventory_device_name/{name}/ for detailed views when users click on specific devices. Filterfiltering by organizationorganization. Use status filters to scopeidentify problematic devices and the dashboardpending parameter to specificdetect networkconfiguration segments.drift.

    Use Case 2: Automated Device Discovery and RegistrationOnboarding

    NetworkStreamline discoverynew toolsdevice can integratedeployment by first checking if devices exist using GET /inventory_device_name/ with IP address or serial number filters, then callingPOST POST /inventory_device_name/ to pre-register newdevices devices.with Usetheir serial numbers and credentials, then use PATCH /inventory_device_name/{name}/operations to update deviceconfigurations statusas devices come online and firmwarereport informationtheir as discovered.capabilities.

    Use Case 3: MaintenanceFirmware andUpdate Compliance TrackingManagement

    GenerateManage maintenancefirmware reportsdeployments by filtering devices using last_status_change_from parameterGET to identify devices thatneeding haven'tupdates, beenPATCH updatedto recently.set Usefirmware_image and firmware_image_is_pending=true, then monitor the pending=truepending_settings parameterfield to findtrack devicesupdate withprogress configurationacross changes awaiting application. Updateyour device information with PATCH operations as maintenance is completed.fleet.

    Use Case 4: Bulk Device Lifecycle ManagementOperations

    TrackPerform maintenance operations across multiple devices fromby procurementfirst using GET with appropriate filters to decommissioning:identify createtarget devicesdevices, withthen iterate through the results using PATCH to trigger operations like POSTreboot, sync, or reconf whenbased theyon arrive,your updatemaintenance locations and configurations with PATCH during deployment, monitor status with filtered GET requests, and remove with DELETE when decommissioned.requirements.

    Use Case 5: Multi-Organization InfrastructureDevice Management

    UseIn multi-tenant environments, use the organization filter parameteron GET requests to separatescope device management for different business units or customers. This enables service providers or large organizationsoperations to maintainspecific separatecustomers, deviceensuring inventoriesproper data isolation while usingmaintaining acentralized singlemanagement API instance.capabilities.

    Best Practices

    • PaginationUse Strategypagination wisely: AlwaysWhen useretrieving large device inventories, implement proper pagination with reasonable limit and offset parameters for large device inventories. Start with smaller page sizesvalues (20-50 items)50-100) to ensureavoid responsivetimeout APIissues calls,and especiallyimprove whenresponse using update_status=true.times.

    • StatusLeverage Updatefiltering Performanceeffectively: TheAlways update_status=trueuse parameterspecific performsfilters real-time(organization, devicetype, checksstatus) rather than retrieving all devices and canfiltering significantlyclient-side. increaseThis responsereduces time. Use it judiciously for critical operationsbandwidth and considerimproves caching results for dashboard displays.performance.

    • ErrorHandle Handlingdevice operations carefully: ImplementOperations retrylike logicreboot, for 5xx errorsfactory, and respectdevice_factory rateare limits.immediate Whenand creatingirreversible. devices,Always handle 409 conflicts gracefully by checking if theverify device alreadynames existsand withconsider themaintenance samewindows serialbefore numbertriggering orthese name.operations.

    • FilteringMonitor Optimizationpending settings: UseRegular specificpolling filtersof likethe organizationpending_settings field helps track configuration synchronization and typeidentify todevices reducewith responsestale payloadconfigurations size.that Combinemay multipleneed filters to create precise device queries rather than filtering large result sets client-side.attention.

    • DateImplement Formatproper Consistencyerror handling: AlwaysDevice useoperations ISOcan formatfail due to connectivity issues, device states, or conflicts. Implement retry logic with exponential backoff for datetimetransient parameters (2024-01-15T14:30:00Z). Include timezone information to avoid ambiguity in multi-region deployments.failures.

    • PartialUse Updatesmeaningful device names: PreferDevice PATCHnames overserve PUTas the primary identifier throughout the API. Use consistent naming conventions that include location, function, and sequence information for mosteasier update operations to avoid accidentally clearing fields that weren't intended to be modified. Reserve PUT for complete data synchronization scenarios.management.

    • SecuritySecure Considerationscredential management: StoreWhen APIcreating tokensor updating devices with authentication credentials, ensure passwords are generated securely and rotatestored themappropriately regularly.in Useyour organization-basedmanagement filtering to ensure users only access devices within their scope of responsibility.systems.

    Back to top