Inventory Connection Profile

The Inventory Connection Profile API allows you to manage and retrieve connection profiles usedthat fordefine integratinghow devices and applications communicate with externalvarious inventoryservices systems.in your infrastructure. These profiles define authentication credentials,specify connection settings,services for device communication, collection services for metrics gathering, and configurationstorage parametersservices neededfor todata connect BookStack with various inventory management platforms and databases.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 providefor access tomanaging connection profiles that enableserve BookStackas templates for device and application connectivity. Each connection profile defines three key service components:

Connection Service: The primary service used to integratecommunicate withand externalpush inventoryparameters, managementsettings, systems.and Thesecommands profilesto 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 essentialthe connectioncollected informationmetrics, such as API endpoints, authentication credentials, database connection strings,logs, and otherevents configurationfrom parametersdevices requiredand toapplications synchronize inventory data.

Connection profiles areact typicallyas usedreusable to:

configurations

that Establishcan securebe connectionsapplied to third-partymultiple inventory systemsitems, Configureensuring consistent connectivity patterns across your infrastructure. This approach simplifies device management by centralizing connection logic and allows for standardized data synchronization settings between BookStackcollection and externalstorage platformsworkflows. Manage

Common authenticationscenarios credentialsinclude forcreating inventory integrations

Define connection parametersprofiles for different inventorydevice datatypes sources(network equipment,

TheseIoT endpointssensors, workservers), togetherenvironments to(production, providestaging, bothdevelopment), listor andorganizational detailedunits viewsthat of available connection profiles, allowing administrators to review configured integrations and their settings. The list endpoint supports filtering and pagination for efficient browsing of multiple profiles, while the detail endpoint provides complete configuration information forrequire specific profiles.

connectivity

Understanding connection profiles is crucial for managing inventory integrations, as they serve as the bridge between BookStack and external inventory management systems, ensuring data flows securely and reliably between platforms.patterns.

---

Endpoints

GET /inventory_connection_profile/

Description: Retrieves a paginated list of all inventory connection profiles with optional filtering capabilities.profiles. This endpoint issupports essentialfiltering by name and pagination controls to manage large datasets. Use this endpoint to browse available connection profiles, search for discoveringspecific availableprofiles inventoryby integrationsname, andor reviewingretrieve theirprofiles basicfor configurationselection details.in user interfaces.

Use Cases:

• Display all configuredavailable inventoryconnection integrationsprofiles in ana adminmanagement dashboard
• FilterSearch for connection profiles by name when assigning them to find specific integrationsdevices
• PaginatePopulate throughdropdown large numbers of connection profileslists for managementprofile interfacesselection during device configuration
• Audit existing inventoryconnection connectionsprofiles forand securitytheir or compliance reviewsconfigurations

Full URL Example:

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

Parameters:

Parameter	Type	In	Required	Description
name	string	query	No	Filter connection profiles by name (supports partial matchingmatch for easy discovery)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 paginationpagination)

cURL Example:

curl -X GET "https://control.zequenze.com/api/v1/inventory_connection_profile/?name=warehouseproduction&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": "WarehouseProduction ManagementNetwork System"Devices",
      "profile_type"connection_service": "rest_api",5,
      "status"collection_service": "active",12,
      "last_sync"storage_service": "2024-01-15T10:30:00Z",
      "organization": "Main Warehouse",
      "created_at": "2024-01-01T09:00:00Z",
      "updated_at": "2024-01-15T10:30:00Z"3
    },
    {
      "id": 2,
      "name": "LegacyProduction InventoryIoT Database"Sensors",
      "profile_type"connection_service": 7,
      "collection_service": 15,
      "storage_service": 3
    },
    {
      "id": 3,
      "name": "database"Production Servers",
      "status"connection_service": "inactive",2,
      "last_sync"collection_service": "2024-01-10T14:22:00Z",8,
      "organization"storage_service": "Legacy Systems",
      "created_at": "2023-12-15T16:45:00Z",
      "updated_at": "2024-01-10T14:22:00Z"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 accessview inventoryconnection profiles

500 Internal Server Error - Server-side error occurred

---

GET /inventory_connection_profile/{id}/

Description: Retrieves detailed information about a specific inventory connection profile,profile includingby fullits configurationunique details, authentication settings, and synchronization parameters.ID. This endpoint providesreturns comprehensivethe complete configuration of a single connection profile, including all associated service IDs. Use this endpoint when you need full details about a specific profile data needed for managingediting, andinspection, troubleshootingor inventoryapplying integrations.to devices.

Use Cases:

• View complete configuration 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 inventory integrationprofile Retrieve connection parameters for debugging synchronization issues DisplayValidate profile settings induring configurationdevice managementonboarding interfaces Audit specific connection profile configurations for security reviewsprocesses

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 inventory 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": "WarehouseProduction ManagementNetwork System"Devices",
  "description"connection_service": "Primary connection to warehouse inventory management system",5,
  "profile_type"collection_service": "rest_api",12,
  "status"storage_service": "active",
  "endpoint_url": "https://warehouse-api.company.com/v2",
  "authentication_type": "api_key",
  "connection_timeout": 30,
  "retry_attempts": 3,
  "sync_frequency": "hourly",
  "last_sync": "2024-01-15T10:30:00Z",
  "last_sync_status": "success",
  "sync_record_count": 1247,
  "organization": "Main Warehouse",
  "created_by": "admin@company.com",
  "created_at": "2024-01-01T09:00:00Z",
  "updated_at": "2024-01-15T10:30:00Z",
  "configuration": {
    "data_mapping": {
      "item_id": "sku",
      "quantity": "stock_count",
      "location": "warehouse_section"
    },
    "filters": {
      "active_items_only": true,
      "exclude_categories": ["obsolete", "discontinued"]
    }
  },
  "health_status": {
    "connectivity": "healthy",
    "authentication": "valid",
    "last_error": null,
    "error_count_24h": 0
  }3
}

Response Codes:

Status	Description
200	Success - Returns detailedthe requested connection profile informationdetails
401	Unauthorized - Invalid or missing API token
403	Forbidden - Insufficient permissions to accessview 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: AdminSetting DashboardUp IntegrationDevice ListCategories

DisplayCreate allstandardized configuredconnection inventoryprofiles connectionsfor different types of devices in anyour administrativeinfrastructure. interface,For showingexample, establish separate profiles for network switches, IoT sensors, and servers, each with appropriate connection, collection, and storage services tailored to their statusspecific and last synchronization times. Use the list endpoint with pagination to handle large numbers of profiles efficiently.requirements.

Use Case 2: ConnectionEnvironment-Based Profile Health MonitoringConfiguration

RetrieveImplement detaileddifferent information about specificconnection profiles tofor monitorvarious theirenvironments health(production, status,staging, checkdevelopment) where each environment requires different service configurations for authenticationsecurity, issues,performance, andor reviewcompliance synchronization statistics for operational monitoring.reasons.

Use Case 3: IntegrationOrganizational Configuration ReviewSegregation

Access complete configuration details for existingDesign connection profiles whenthat settingalign upwith similarorganizational integrationsboundaries, ensuring different departments or troubleshootingbusiness synchronizationunits problemsuse withappropriate externalservices inventoryfor systems.data collection and storage while maintaining proper access controls.

Use Case 4: SecurityProfile AuditSelection Interface

Build user interfaces that allow administrators to browse and Complianceselect

Filter and review all inventoryappropriate connection profiles towhen ensureonboarding propernew authenticationdevices methodsor arereconfiguring inexisting useinventory and that connection configurations meet security and compliance requirements.items.

Use Case 5: TroubleshootingBulk SyncDevice IssuesConfiguration

ExamineUse detailedconnection profileprofiles informationto includingstandardize errorthe logs,configuration syncof statistics,multiple devices simultaneously, ensuring consistent connectivity patterns and configuration parameters to diagnose and resolve inventory data synchronizationhandling problems.across your infrastructure.

---

Best Practices

• Use Pagination ManagementEffectively: When listingretrieving large lists of connection profiles, useimplement appropriateproper pagination using the limit valuesand (10-50)offset parameters to balanceavoid performanceoverwhelming withyour usability,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 configured integrations.profiles.

ErrorCache HandlingProfile 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 implementcheck properthe errorresponse handling for 404 responsesstatus when accessingretrieving specific profiles,profiles by ID, as profiles may be deleted or accessmodified permissionsby mayother change.administrators.

SecurityPlan ConsiderationsService Dependencies: TreatWhen designing connection profileprofiles, data as sensitive information. The detailed endpoint may expose configuration parametersensure that couldthe bereferenced usedconnection, collection, and storage services are properly configured and accessible before applying profiles to compromise inventory integrations.devices.

CachingDocument StrategyProfile Purpose: CacheMaintain clear naming conventions for connection profileprofiles datathat appropriately,indicate buttheir ensureintended cacheuse invalidationcase, alignsenvironment, withor thedevice frequencytype ofto configurationimprove changesoperational in your environment.clarity.

FilteringHandle EfficiencyErrors Gracefully: UseImplement theproper nameerror filterhandling parameterfor cases where profiles are not found or access is denied, providing meaningful feedback to reduceusers dataabout transferwhy andoperations improve response times when searching for specific connection profiles in large deployments.

Monitoring Integration: Regularly check the health_status and last_sync fields to proactively identify and address connectivity or synchronization issues before they impact inventory data accuracy.failed.

---