​

Configuration Manager API

​

Base URL

​

Authentication

Authorization: Bearer YOUR_TOKEN

​

Architecture Overview

• Securely encrypts sensitive configuration values using AES-256-GCM algorithm
• Provides a RESTful API for managing configurations
• Integrates with other services via event-driven architecture
• Controls access through authentication and authorization
• Performs health checks before saving configurations

​

Key Features

• Secure Storage: All sensitive configurations are encrypted using AES-256-GCM algorithm
• Health Checks: Built-in validation of configuration parameters before storage
• Event Notifications: Publishes events when critical configurations change
• Centralized Management: Single service to control settings across the system
• AI Model Management: Advanced provider management for AI models with support for multiple models per provider
• Connector Integration: Support for various connectors including Google Workspace, Atlassian, OneDrive, and SharePoint

​

Supported Configurations

1. Storage Configurations - AWS S3, Azure Blob, or Local storage settings
2. Authentication Configurations - Azure AD, Google, Microsoft, SSO, and OAuth settings
3. Database Configurations - MongoDB, ArangoDB, and Qdrant settings
4. Key-Value Store Configurations - Redis settings
5. Message Broker Configurations - Kafka settings
6. SMTP Configurations - Email service settings
7. AI Models Configurations - Settings for LLM, embedding, OCR, SLM, reasoning, and multiModal models
8. Connector Configurations - Google Workspace, Atlassian, OneDrive, and SharePoint integrations
9. Public URL Configurations - Frontend and connector URLs
10. Metrics Collection Configurations - Settings for metrics gathering

​

API Endpoints

{
  "storageType": "s3",
  "s3AccessKeyId": "YOUR_ACCESS_KEY_ID",
  "s3SecretAccessKey": "YOUR_SECRET_ACCESS_KEY",
  "s3Region": "us-west-2",
  "s3BucketName": "your-bucket-name"
}

{
  "storageType": "azureBlob",
  "azureBlobConnectionString": "DefaultEndpointsProtocol=https;AccountName=...",
  "containerName": "your-container-name"
}

{
  "storageType": "azureBlob",
  "accountName": "your-account-name",
  "accountKey": "your-account-key",
  "containerName": "your-container-name",
  "endpointProtocol": "https",
  "endpointSuffix": "core.windows.net"
}

{
  "storageType": "local",
  "mountName": "PipesHub",
  "baseUrl": "http://localhost:3000"
}

{
  "host": "smtp.example.com",
  "port": 587,
  "username": "your-username",
  "password": "your-password",
  "fromEmail": "no-reply@example.com"
}

{
  "clientId": "your-client-id",
  "tenantId": "your-tenant-id"
}

{
  "clientId": "your-client-id",
  "tenantId": "your-tenant-id"
}

{
  "clientId": "your-client-id"
}

{
  "entryPoint": "https://sso.example.com/saml",
  "certificate": "-----BEGIN CERTIFICATE-----\nMIIC...\n-----END CERTIFICATE-----",
  "emailKey": "email"
}

{
  "providerName": "Custom OAuth Provider",
  "clientId": "your-client-id",
  "clientSecret": "your-client-secret",
  "authorizationUrl": "https://provider.com/oauth/authorize",
  "tokenEndpoint": "https://provider.com/oauth/token",
  "userInfoEndpoint": "https://provider.com/oauth/userinfo",
  "scope": "read:user",
  "redirectUri": "https://yourapp.com/callback"
}

{
  "uri": "mongodb://username:password@hostname:port/database"
}

{
  "url": "http://localhost:8529",
  "username": "root",
  "password": "password"
}

{
  "host": "localhost",
  "port": 6333,
  "grpcPort": 6334,
  "apiKey": "your-api-key"
}

{
  "host": "redis.example.com",
  "port": 6379,
  "password": "your-password",
  "tls": true
}

{
  "brokers": ["kafka-1:9092", "kafka-2:9092"],
  "sasl": {
    "mechanism": "plain",
    "username": "your-username",
    "password": "your-password"
  }
}

{
  "llm": [
    {
      "provider": "openAI",
      "configuration": {
        "model": "gpt-4o,gpt-4o-mini",
        "apiKey": "your-openai-key",
        "organizationId": "your-org-id"
      },
      "isMultimodal": false,
      "isDefault": true
    }
  ],
  "embedding": [
    {
      "provider": "openAI",
      "configuration": {
        "model": "text-embedding-ada-002",
        "apiKey": "your-openai-key"
      },
      "isMultimodal": false,
      "isDefault": true
    }
  ]
}

{
  "modelType": "llm",
  "provider": "anthropic",
  "configuration": {
    "model": "claude-3-opus",
    "apiKey": "your-anthropic-key"
  },
  "isMultimodal": true,
  "isDefault": false
}

{
  "provider": "anthropic",
  "configuration": {
    "model": "claude-3-sonnet",
    "apiKey": "your-updated-anthropic-key"
  },
  "isMultimodal": true,
  "isDefault": true
}

{
  "clientId": "your-google-client-id",
  "clientSecret": "your-google-client-secret",
  "enableRealTimeUpdates": true,
  "topicName": "gmail-updates"
}

{
  "access_token": "your-access-token",
  "refresh_token": "your-refresh-token",
  "access_token_expiry_time": 1640995200000,
  "refresh_token_expiry_time": 1672531200000,
  "enableRealTimeUpdates": true,
  "topicName": "gmail-updates"
}

{
  "clientId": "your-atlassian-client-id",
  "clientSecret": "your-atlassian-client-secret"
}

{
  "clientId": "your-microsoft-client-id",
  "clientSecret": "your-microsoft-client-secret",
  "tenantId": "your-tenant-id",
  "hasAdminConsent": true
}

{
  "clientId": "your-microsoft-client-id",
  "clientSecret": "your-microsoft-client-secret",
  "tenantId": "your-tenant-id",
  "sharepointDomain": "yourcompany.sharepoint.com",
  "hasAdminConsent": true
}

{
  "url": "https://app.example.com"
}

{
  "url": "https://connectors.example.com"
}

{
  "enableMetricCollection": true
}

{
  "pushIntervalMs": 30000
}

{
  "serverUrl": "https://metrics.example.com"
}

​

Encryption and Security

• Secret Key Hashing: The secret key used for encryption is hashed using SHA-256 for added security
• Per-Configuration Encryption: Each sensitive configuration is individually encrypted
• Fine-grained Access Control: API endpoints require appropriate authentication and authorization
• Health Checks: Automatic validation of configurations before storage

​

Event-Driven Architecture

• LLM Configured Event: When AI models are configured or updated
• Connector Public URL Changed Event: When connector URLs are updated
• Gmail Updates Enabled/Disabled Event: When Gmail real-time updates are toggled

​

Health Checks

• Kafka Health Check: Verifies Kafka broker connectivity and validates broker URLs
• Redis Health Check: Tests Redis connection with timeout and retry logic
• Qdrant Health Check: Ensures Qdrant vector database is accessible via HTTP
• MongoDB Health Check: Validates MongoDB connection using ping command
• ArangoDB Health Check: Confirms ArangoDB connection and authentication
• AI Models Health Check: Validates AI model configurations with provider APIs

​

Schema Definitions

// Azure AD Config
interface AzureAdConfig {
  clientId: string;
  tenantId: string; // defaults to "common"
  authority: string;
}

// SSO Config
interface SsoConfig {
  entryPoint: string;
  certificate: string; // Certificate content (BEGIN/END markers removed)
  emailKey: string;
}

// Google Auth Config
interface GoogleAuthConfig {
  clientId: string;
}

// Microsoft Auth Config
interface MicrosoftAuthConfig {
  clientId: string;
  tenantId: string; // defaults to "common"
  authority: string;
}

// OAuth Config
interface OAuthConfig {
  providerName: string;
  clientId: string;
  clientSecret?: string;
  authorizationUrl?: string;
  tokenEndpoint?: string;
  userInfoEndpoint?: string;
  scope?: string;
  redirectUri?: string;
}