Skip to main content

Inventory Connection Profile

Endpoints Summary

Method Path Swagger GET /inventory_connection_profile/ Swagger ↗ GET /inventory_connection_profile/{id}/ Swagger ↗

The Inventory Connection Profile API allows you to managemanages connection profiles that define how the system communicates with and collects data from devices and applications communicate with various services in your infrastructure.inventory. These profiles specify connection services for device communication, collection services for metrics gathering, and storage services for data persistence.

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

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

Overview

The Inventory Connection Profile API provides endpoints for managing connection profiles thatProfiles serve as configuration templates forthat devicedefine how the Zequenze Control system establishes connections with various devices and applicationapplications connectivity.in your network infrastructure. Each connection profile definescombines three key service components:types:

  • Connection Service: TheHandles primarycommunication service used to communicateprotocols and pushcommand parameters,execution settings, and commands towith devices and applications
  • Collection Service: An additionalManages data collection service to pullfor metrics, logs, and events from devices and applications
  • Storage Service: ADefines servicewhere toand store thehow collected metrics,data logs,is and events from devices and applicationsstored

ConnectionThese profiles actare asessential for inventory management workflows, allowing you to standardize connection methods across similar device types while maintaining flexibility for different environments. By creating reusable configurationsprofiles, thatyou can be applied to multiple inventory items, ensuringensure consistent connectivity patterns across your infrastructure. This approach simplifies device management by centralizing connection logic and allows for standardized data collection and storagedevice workflows.management across your infrastructure.

Common scenarios include creating profiles for different device typescategories (network equipment, servers, IoT sensors, servers)devices), environmentsenvironment types (production, staging, development), or organizational units that requirewith specific connectivitycompliance patterns.requirements.

Endpoints

GET /inventory_connection_profile/

Description: Retrieves a paginated list of all inventory connection profiles.profiles in your organization. This endpoint supports filtering by profile name and includes pagination controls tofor managemanaging large datasets. Use this endpoint to browse available connection profiles, search for specific profiles by name, or retrieve profiles for selection in user interfaces.

Use Cases:

  • Display allBrowse available connection profiles in a management dashboard
Search for connection profiles by name whenbefore assigning them to devices PopulateSearch for specific profiles by name for configuration management Audit connection profile configurations across your organization Build dropdown lists for profile selection duringin deviceuser configuration Audit existing connection profiles and their configurationsinterfaces

Full URL Example:

https://control.zequenze.com/api/v1/inventory_connection_profile/?name=production&limit=20&offset=0

Parameters:

Parameter Type In Required Description
name string query No Filter connection profiles by name (supports partial match supported)matching)
limit integer query No Number of results to return per page (default: 20, max: 100)
offset integer query No The initial index from which to return the results (used for pagination)pagination

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_connection_profile/?name=productionnetwork&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_connection_profile/?limit=10&offset=10",
  "previous": null,
  "results": [
    {
      "id": 1,
      "name": "Production Network Devices"Equipment Profile",
      "connection_service": 5,101,
      "collection_service": 12,201,
      "storage_service": 3301
    },
    {
      "id": 2,
      "name": "ProductionServer IoTMonitoring Sensors"Profile",
      "connection_service": 7,102,
      "collection_service": 15,202,
      "storage_service": 3301
    },
    {
      "id": 3,
      "name": "ProductionIoT Servers"Device Profile",
      "connection_service": 2,103,
      "collection_service": 8,203,
      "storage_service": 4302
    }
  ]
}

Response Codes:

Status Description
200 Success - Returns paginatedthe list of connection profiles
401 Unauthorized - Invalid or missing APIauthentication token
403 Forbidden - Insufficient permissions to view connectionaccess profiles
500 Internal Server Error - Server-side error occurred

GET /inventory_connection_profile/{id}/

Description: Retrieves detailed information about a specific inventory connection profile by its unique ID.identifier. This endpoint returns theprovides complete profile configuration of a single connection profile, including all associated service IDs. Use this endpoint when you need full details about a specific profile for editing, inspection, or applying to devices.references.

Use Cases:

  • View complete configuration details of a connection profile before applying ita profile to devices
Verify profile settings during troubleshooting connectivity issues Retrieve profile information for editingconfiguration ormanagement cloning purposesworkflows Inspect service configurations associated with a specific profile ValidateDisplay profile settingsdetails duringin deviceadministrative onboarding processesinterfaces

Full URL Example:

https://control.zequenze.com/api/v1/inventory_connection_profile/1/

Parameters:

Parameter Type In Required Description
id integer path Yes Unique identifier of the connection profile to retrieve

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_connection_profile/1/" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "id": 1,
  "name": "Production Network Devices"Equipment Profile",
  "connection_service": 5,101,
  "collection_service": 12,201,
  "storage_service": 3301
}

Response Codes:

Status Description
200 Success - Returns the requested connection profile details
401 Unauthorized - Invalid or missing APIauthentication token
403 Forbidden - Insufficient permissions to viewaccess this connection profile
404 Not Found - Connection profile with specified ID does not exist
500 Internal Server Error - Server-side error occurred

Common Use Cases

Use Case 1: SettingProfile UpDiscovery Deviceand CategoriesSelection

CreateWhen standardizedsetting connectionup profiles for different types ofnew devices in your infrastructure.inventory, Foruse example,the establishlist separateendpoint to discover available connection profiles forthat networkmatch switches,your IoTrequirements. sensors,Filter andby servers,name eachto withfind appropriateprofiles specific to your device type or environment.

Use Case 2: Profile Configuration Verification

Before applying a connection profile to critical infrastructure, retrieve the specific profile details to verify the connection, collection, and storage servicesservice tailoredconfigurations toalign theirwith specificyour operational requirements.

Use Case 2:3: Environment-BasedInventory ConfigurationManagement Dashboard

ImplementBuild differentadministrative dashboards that display all available connection profiles forwith varioustheir environmentsconfigurations, (production,allowing staging,infrastructure development)teams whereto eachunderstand environmentthe requires different service configurations for security, performance, or compliance reasons.

Use Case 3: Organizational Segregation

Designstandardized connection profilesmethods thatavailable alignacross withthe organizational boundaries, ensuring different departments or business units use appropriate services for data collection and storage while maintaining proper access controls.organization.

Use Case 4: ProfileAutomated SelectionDevice InterfaceOnboarding

BuildIntegrate userthese interfacesendpoints thatinto allowautomated administratorsdevice toonboarding browseworkflows andwhere selectthe system automatically selects appropriate connection profiles whenbased onboardingon newdevice devicescharacteristics or reconfiguringorganizational existing inventory items.policies.

Use Case 5: BulkCompliance Deviceand ConfigurationAuditing

Use connectionthe profileslist endpoint to standardizeregularly theaudit configurationconnection ofprofile multiple devices simultaneously,configurations, ensuring consistentthey connectivitycomply patternswith security policies and dataoperational handlingstandards across yourdifferent infrastructure.environments or organizational units.

Best Practices

  • Use Pagination EffectivelyManagement: When retrievingdealing with large listsnumbers of connection profiles, always implement proper pagination using the limit and offset parameters to avoid overwhelmingperformance your applicationissues and improve response times.timeouts.

  • ImplementProfile Name-BasedNaming SearchConventions: UtilizeUse descriptive names when filtering profiles that clearly indicate the nameintended filteruse parametercase (e.g., "prod-network-switches", "staging-linux-servers") to helpimprove users quickly find relevant connection profiles, especially in environments with many profiles.discoverability.

  • CacheCaching Profile DataStrategy: ConsiderCache cachingfrequently connectionaccessed profile information in your application to reduce API calls, especiallybut forimplement appropriate cache invalidation when profiles that are frequentlymodified referencedthrough duringother device operations.interfaces.

  • ValidateError Profile ExistenceHandling: Always checkhandle the404 responseresponses statusgracefully when retrieving specific profiles by ID,profiles, as profilesthey may be deleted or modifiedmoved bybetween otherAPI administrators.calls in dynamic environments.

  • PlanSecurity ServiceConsiderations: DependenciesConnection profiles may contain sensitive configuration references. Ensure proper access controls are in place and audit profile access regularly.

Integration Workflows: When designingintegrating connectionwith profiles,device ensuremanagement systems, validate that the referenced connection,service collection,IDs (connection_service, collection_service, storage_service) exist and storage services are properly configured and accessible before applying profiles to devices.

Document Profile Purpose: Maintain clear naming conventions for connection profiles that indicate their intended use case, environment, or device type to improve operational clarity.

Handle Errors Gracefully: Implement proper error handling for cases where profiles are not found or access is denied, providing meaningful feedback to users about why operations failed.

Back to top