Inventory Connection Profile

The Inventory Connection Profile API allows you to manage connection profiles that define how devices and applications communicate with various services in your infrastructure. 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 that serve as templates for device and application connectivity. Each connection profile defines three key service components:

Connection Service: The primary service used to communicate and push parameters, settings, and commands to devices and applications
Collection Service: An additional data collection service to pull metrics, logs, and events from devices and applications
Storage Service: A service to store the collected metrics, logs, and events from devices and applications

Connection profiles act as reusable configurations that can be applied to multiple inventory items, ensuring consistent connectivity patterns across your infrastructure. This approach simplifies device management by centralizing connection logic and allows for standardized data collection and storage workflows.

Common scenarios include creating profiles for different device types (network equipment, IoT sensors, servers), environments (production, staging, development), or organizational units that require specific connectivity patterns.

Endpoints

GET /inventory_connection_profile/

Description: Retrieves a paginated list of all inventory connection profiles. This endpoint supports filtering by name and pagination controls to manage 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 all available connection profiles in a management dashboard
Search for connection profiles by name when assigning them to devices
Populate dropdown lists for profile selection during device configuration
Audit existing connection profiles and their configurations

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 (partial match supported)
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)

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_connection_profile/?name=production&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",
      "connection_service": 5,
      "collection_service": 12,
      "storage_service": 3
    },
    {
      "id": 2,
      "name": "Production IoT Sensors",
      "connection_service": 7,
      "collection_service": 15,
      "storage_service": 3
    },
    {
      "id": 3,
      "name": "Production Servers",
      "connection_service": 2,
      "collection_service": 8,
      "storage_service": 4
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginated list of connection profiles
401	Unauthorized - Invalid or missing API token
403	Forbidden - Insufficient permissions to view connection 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. This endpoint returns the complete 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.

Use Cases:

View complete details of a connection profile before applying it to devices
Retrieve profile information for editing or cloning purposes
Inspect service configurations associated with a specific profile
Validate profile settings during device onboarding processes

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",
  "connection_service": 5,
  "collection_service": 12,
  "storage_service": 3
}

Response Codes:

Status	Description
200	Success - Returns the requested connection profile details
401	Unauthorized - Invalid or missing API token
403	Forbidden - Insufficient permissions to view 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: Setting Up Device Categories

Create standardized connection profiles for different types of devices in your infrastructure. For example, establish separate profiles for network switches, IoT sensors, and servers, each with appropriate connection, collection, and storage services tailored to their specific requirements.

Use Case 2: Environment-Based Configuration

Implement different connection profiles for various environments (production, staging, development) where each environment requires different service configurations for security, performance, or compliance reasons.

Use Case 3: Organizational Segregation

Design connection profiles that align with organizational boundaries, ensuring different departments or business units use appropriate services for data collection and storage while maintaining proper access controls.

Use Case 4: Profile Selection Interface

Build user interfaces that allow administrators to browse and select appropriate connection profiles when onboarding new devices or reconfiguring existing inventory items.

Use Case 5: Bulk Device Configuration

Use connection profiles to standardize the configuration of multiple devices simultaneously, ensuring consistent connectivity patterns and data handling across your infrastructure.

Best Practices

Use Pagination Effectively: When retrieving large lists of connection profiles, implement proper pagination using the limit and offset parameters to avoid overwhelming your application and improve response times.
Implement Name-Based Search: Utilize the name filter parameter to help users quickly find relevant connection profiles, especially in environments with many profiles.
Cache Profile Data: Consider caching connection profile information in your application to reduce API calls, especially for profiles that are frequently referenced during device operations.
Validate Profile Existence: Always check the response status when retrieving specific profiles by ID, as profiles may be deleted or modified by other administrators.
Plan Service Dependencies: When designing connection profiles, ensure that the referenced connection, collection, 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.