Inventory Connection Profile

Endpoints Summary

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

The Inventory Connection Profile API manages connection profiles that define how the system communicates with and collects data from devices and applications in your 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

Inventory Connection Profiles serve as configuration templates that define how the Zequenze Control system establishes connections with various devices and applications in your network infrastructure. Each profile combines three key service types:

Connection Service: Handles communication protocols and command execution with devices
Collection Service: Manages data collection for metrics, logs, and events
Storage Service: Defines where and how collected data is stored

These profiles are essential for inventory management workflows, allowing you to standardize connection methods across similar device types while maintaining flexibility for different environments. By creating reusable profiles, you can ensure consistent data collection and device management across your infrastructure.

Common scenarios include creating profiles for different device categories (network equipment, servers, IoT devices), environment types (production, staging, development), or organizational units with specific compliance requirements.

Endpoints

GET /inventory_connection_profile/

Description: Retrieves a paginated list of all inventory connection profiles in your organization. This endpoint supports filtering by profile name and includes pagination controls for managing large datasets.

Use Cases:

Browse available connection profiles before assigning them to devices
Search for specific profiles by name for configuration management
Audit connection profile configurations across your organization
Build dropdown lists for profile selection in user interfaces

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 profiles by name (supports partial 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 results for pagination

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_connection_profile/?name=network&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": "Network Equipment Profile",
      "connection_service": 101,
      "collection_service": 201,
      "storage_service": 301
    },
    {
      "id": 2,
      "name": "Server Monitoring Profile",
      "connection_service": 102,
      "collection_service": 202,
      "storage_service": 301
    },
    {
      "id": 3,
      "name": "IoT Device Profile",
      "connection_service": 103,
      "collection_service": 203,
      "storage_service": 302
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns the list of connection profiles
401	Unauthorized - Invalid or missing authentication token
403	Forbidden - Insufficient permissions to access 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 identifier. This endpoint provides complete profile configuration including all associated service references.

Use Cases:

View complete configuration details before applying a profile to devices
Verify profile settings during troubleshooting connectivity issues
Retrieve profile information for configuration management workflows
Display profile details in administrative interfaces

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 Equipment Profile",
  "connection_service": 101,
  "collection_service": 201,
  "storage_service": 301
}

Response Codes:

Status	Description
200	Success - Returns the connection profile details
401	Unauthorized - Invalid or missing authentication token
403	Forbidden - Insufficient permissions to access this 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: Profile Discovery and Selection

When setting up new devices in your inventory, use the list endpoint to discover available connection profiles that match your requirements. Filter by name to find profiles 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 service configurations align with your operational requirements.

Use Case 3: Inventory Management Dashboard

Build administrative dashboards that display all available connection profiles with their configurations, allowing infrastructure teams to understand the standardized connection methods available across the organization.

Use Case 4: Automated Device Onboarding

Integrate these endpoints into automated device onboarding workflows where the system automatically selects appropriate connection profiles based on device characteristics or organizational policies.

Use Case 5: Compliance and Auditing

Use the list endpoint to regularly audit connection profile configurations, ensuring they comply with security policies and operational standards across different environments or organizational units.

Best Practices

Pagination Management: When dealing with large numbers of connection profiles, always implement proper pagination using the limit and offset parameters to avoid performance issues and timeouts.
Profile Naming Conventions: Use descriptive names when filtering profiles that clearly indicate the intended use case (e.g., "prod-network-switches", "staging-linux-servers") to improve discoverability.
Caching Strategy: Cache frequently accessed profile information to reduce API calls, but implement appropriate cache invalidation when profiles are modified through other interfaces.
Error Handling: Always handle 404 responses gracefully when retrieving specific profiles, as they may be deleted or moved between API calls in dynamic environments.
Security Considerations: Connection profiles may contain sensitive configuration references. Ensure proper access controls are in place and audit profile access regularly.
Integration Workflows: When integrating with device management systems, validate that referenced service IDs (connection_service, collection_service, storage_service) exist and are properly configured before applying profiles to devices.