Configuration Manager API

The Configuration Manager Service provides a centralized way to manage configuration settings across your organization’s services. It securely stores various configuration parameters in a key-value store (ETCD by default) and provides APIs to manage these configurations.

Base URL

All endpoints are prefixed with /api/v1/configurationManager

Authentication

All endpoints require authentication via Bearer token:

Authorization: Bearer YOUR_TOKEN

Architecture Overview

The Configuration Manager Service is built on a Node.js backend that leverages ETCD (or other compatible key-value stores) for secure configuration storage. The service:

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

The Configuration Manager handles various types of configurations:

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

API Endpoints

Storage Configuration

The Storage Configuration API enables you to configure different storage backends for your application.

POST /storageConfig - Set Storage Configuration

Configure the storage service with specific backend details.

Request
Response

Endpoint: POST /api/v1/configurationManager/storageConfigRequest Body Parameters:

Parameter	Type	Required	Description
storageType	string	Yes	Type of storage (“s3”, “azureBlob”, or “local”)

S3 Storage Config:

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

Azure Blob Storage Config (Connection String):

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

Azure Blob Storage Config (Individual Parameters):

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

Local Storage Config:

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

Status: 200 OK

{
  "message": "Storage configuration saved successfully"
}

GET /storageConfig - Get Storage Configuration

Retrieve the current storage configuration.

Request
Response

Endpoint: GET /api/v1/configurationManager/storageConfig

Status: 200 OKS3 Response:

{
  "storageType": "s3",
  "accessKeyId": "YOUR_ACCESS_KEY_ID",
  "secretAccessKey": "YOUR_SECRET_ACCESS_KEY",
  "region": "us-west-2",
  "bucketName": "your-bucket-name"
}

Azure Blob Response:

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

Local Storage Response:

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

SMTP Configuration

Configure email service settings for your application.

POST /smtpConfig - Set SMTP Configuration

Configure SMTP settings for email services.

Request
Response

Endpoint: POST /api/v1/configurationManager/smtpConfigRequest Body Parameters:

Parameter	Type	Required	Description
host	string	Yes	SMTP server host
port	number	Yes	SMTP server port
username	string	No	SMTP username
password	string	No	SMTP password
fromEmail	string	Yes	Default sender email

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

Status: 200 OK

{
  "message": "SMTP config created successfully"
}

GET /smtpConfig - Get SMTP Configuration

Retrieve the current SMTP configuration.

Request
Response

Endpoint: GET /api/v1/configurationManager/smtpConfig

Status: 200 OK

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

Authentication Configuration

The Authentication Configuration API allows you to manage various authentication providers.

Azure AD Authentication

Configure Azure Active Directory authentication.

POST /authConfig/azureAd - Set Azure AD Config

Request
Response

Endpoint: POST /api/v1/configurationManager/authConfig/azureAdRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Azure AD client ID
tenantId	string	No	Azure AD tenant ID (defaults to “common”)

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

Status: 200 OK

{
  "message": "Azure AD config created successfully"
}

GET /authConfig/azureAd - Get Azure AD Config

Request
Response

Endpoint: GET /api/v1/configurationManager/authConfig/azureAd

Status: 200 OK

{
  "clientId": "your-client-id",
  "tenantId": "your-tenant-id",
  "authority": "https://login.microsoftonline.com/your-tenant-id"
}

Microsoft Authentication

Configure Microsoft authentication.

POST /authConfig/microsoft - Set Microsoft Config

Request
Response

Endpoint: POST /api/v1/configurationManager/authConfig/microsoftRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Microsoft client ID
tenantId	string	No	Microsoft tenant ID (defaults to “common”)

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

Status: 200 OK

{
  "message": "Microsoft Auth config created successfully"
}

GET /authConfig/microsoft - Get Microsoft Config

Request
Response

Endpoint: GET /api/v1/configurationManager/authConfig/microsoft

Status: 200 OK

{
  "clientId": "your-client-id",
  "tenantId": "your-tenant-id",
  "authority": "https://login.microsoftonline.com/your-tenant-id"
}

Google Authentication

Configure Google authentication.

POST /authConfig/google - Set Google Config

Request
Response

Endpoint: POST /api/v1/configurationManager/authConfig/googleRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Google client ID

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

Status: 200 OK

{
  "message": "Google Auth config created successfully"
}

GET /authConfig/google - Get Google Config

Request
Response

Endpoint: GET /api/v1/configurationManager/authConfig/google

Status: 200 OK

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

SSO Authentication

Configure SAML-based Single Sign-On.

POST /authConfig/sso - Set SSO Config

Request
Response

Endpoint: POST /api/v1/configurationManager/authConfig/ssoRequest Body Parameters:

Parameter	Type	Required	Description
entryPoint	string	Yes	SSO entry point URL
certificate	string	Yes	SSO certificate
emailKey	string	Yes	Key for email in SSO response

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

Status: 200 OK

{
  "message": "Sso config created successfully"
}

GET /authConfig/sso - Get SSO Config

Request
Response

Endpoint: GET /api/v1/configurationManager/authConfig/sso

Status: 200 OK

{
  "entryPoint": "https://sso.example.com/saml",
  "certificate": "MIICertificateContent...",
  "emailKey": "email"
}

OAuth Authentication

Configure custom OAuth authentication.

POST /authConfig/oauth - Set OAuth Config

Request
Response

Endpoint: POST /api/v1/configurationManager/authConfig/oauthRequest Body Parameters:

Parameter	Type	Required	Description
providerName	string	Yes	OAuth provider name
clientId	string	Yes	OAuth client ID
clientSecret	string	No	OAuth client secret
authorizationUrl	string	No	Authorization URL
tokenEndpoint	string	No	Token endpoint URL
userInfoEndpoint	string	No	User info endpoint URL
scope	string	No	OAuth scope
redirectUri	string	No	Redirect URI

{
  "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"
}

Status: 200 OK

{
  "message": "OAuth config created successfully"
}

GET /authConfig/oauth - Get OAuth Config

Request
Response

Endpoint: GET /api/v1/configurationManager/authConfig/oauth

Status: 200 OK

{
  "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"
}

Database Configuration

Configure database connections for your application. All database configurations include automatic health checks before saving.

MongoDB Configuration

Configure MongoDB database connection.

POST /mongoDBConfig - Set MongoDB Config

Request
Response

Endpoint: POST /api/v1/configurationManager/mongoDBConfigRequest Body Parameters:

Parameter	Type	Required	Description
uri	string	Yes	MongoDB connection URI

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

Status: 200 OK

{
  "message": "Mongo DB config created successfully"
}

GET /mongoDBConfig - Get MongoDB Config

Request
Response

Endpoint: GET /api/v1/configurationManager/mongoDBConfig

Status: 200 OK

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

ArangoDB Configuration

Configure ArangoDB database connection.

POST /arangoDBConfig - Set ArangoDB Config

Request
Response

Endpoint: POST /api/v1/configurationManager/arangoDBConfigRequest Body Parameters:

Parameter	Type	Required	Description
url	string	Yes	ArangoDB connection URL
username	string	No	ArangoDB username
password	string	No	ArangoDB password

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

Status: 200 OK

{
  "message": "Arango DB config created successfully"
}

GET /arangoDBConfig - Get ArangoDB Config

Request
Response

Endpoint: GET /api/v1/configurationManager/arangoDBConfig

Status: 200 OK

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

Qdrant Configuration

Configure Qdrant vector database connection.

POST /qdrantConfig - Set Qdrant Config

Request
Response

Endpoint: POST /api/v1/configurationManager/qdrantConfigRequest Body Parameters:

Parameter	Type	Required	Description
host	string	Yes	Qdrant server host
port	number	Yes	Qdrant HTTP port
grpcPort	number	No	Qdrant gRPC port
apiKey	string	No	Qdrant API key (not required for localhost)

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

Status: 200 OK

{
  "message": "Qdrant config created successfully",
  "warningMessage": "localhost does not require an API key"
}

GET /qdrantConfig - Get Qdrant Config

Request
Response

Endpoint: GET /api/v1/configurationManager/qdrantConfig

Status: 200 OK

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

Key-Value Store Configuration

Configure Redis as a key-value store with automatic health checks.

POST /redisConfig - Set Redis Config

Request
Response

Endpoint: POST /api/v1/configurationManager/redisConfigRequest Body Parameters:

Parameter	Type	Required	Description
host	string	Yes	Redis server host
port	number	Yes	Redis server port
password	string	No	Redis password
tls	boolean	No	Enable TLS for Redis connection

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

Status: 200 OK

{
  "message": "Redis config created successfully"
}

GET /redisConfig - Get Redis Config

Request
Response

Endpoint: GET /api/v1/configurationManager/redisConfig

Status: 200 OK

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

Message Broker Configuration

Configure Kafka message broker with automatic health checks and broker validation.

POST /kafkaConfig - Set Kafka Config

Request
Response

Endpoint: POST /api/v1/configurationManager/kafkaConfigRequest Body Parameters:

Parameter	Type	Required	Description
brokers	string[]	Yes	Array of Kafka broker URLs
sasl	object	No	SASL authentication details

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

Status: 200 OK

{
  "message": "Kafka config created successfully",
  "warningMessage": "Unreachable-Brokers detected : \"kafka-3:9092\""
}

GET /kafkaConfig - Get Kafka Config

Request
Response

Endpoint: GET /api/v1/configurationManager/kafkaConfig

Status: 200 OK

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

AI Models Configuration

Configure AI models for various tasks with advanced provider management.

Complete AI Models Configuration

Manage the complete AI models configuration for all model types.

POST /aiModelsConfig - Set AI Models Config

Request
Response

Endpoint: POST /api/v1/configurationManager/aiModelsConfigRequest Body Parameters: At least one AI model type must be configured.

{
  "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
    }
  ]
}

Status: 200 OK

{
  "message": "AI config created successfully"
}

GET /aiModelsConfig - Get AI Models Config

Request
Response

Endpoint: GET /api/v1/configurationManager/aiModelsConfig

Status: 200 OK

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

AI Models Management

Advanced management endpoints for AI model providers.

GET /ai-models - Get All AI Models

Request
Response

Endpoint: GET /api/v1/configurationManager/ai-models

Status: 200 OK

{
  "status": "success",
  "models": {
    "ocr": [],
    "embedding": [
      {
        "provider": "openAI",
        "configuration": {
          "model": "text-embedding-ada-002",
          "apiKey": "your-openai-key"
        },
        "modelKey": "uuid-generated-key",
        "isMultimodal": false,
        "isDefault": true
      }
    ],
    "slm": [],
    "llm": [
      {
        "provider": "openAI",
        "configuration": {
          "model": "gpt-4o,gpt-4o-mini",
          "apiKey": "your-openai-key"
        },
        "modelKey": "uuid-generated-key",
        "isMultimodal": false,
        "isDefault": true
      }
    ],
    "reasoning": [],
    "multiModal": []
  },
  "message": "AI models retrieved successfully"
}

GET /ai-models/{modelType} - Get Models by Type

Request
Response

Endpoint: GET /api/v1/configurationManager/ai-models/{modelType}Path Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal

Status: 200 OK

{
  "status": "success",
  "models": [
    {
      "provider": "openAI",
      "configuration": {
        "model": "gpt-4o,gpt-4o-mini",
        "apiKey": "your-openai-key"
      },
      "modelKey": "uuid-generated-key",
      "isMultimodal": false,
      "isDefault": true
    }
  ],
  "message": "Found 1 llm models"
}

GET /ai-models/available/{modelType} - Get Available Models

Request
Response

Endpoint: GET /api/v1/configurationManager/ai-models/available/{modelType}Path Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal

Status: 200 OK

{
  "status": "success",
  "models": [
    {
      "modelType": "llm",
      "provider": "openAI",
      "modelName": "gpt-4o",
      "modelKey": "uuid-generated-key",
      "isMultimodal": false,
      "isDefault": true
    },
    {
      "modelType": "llm",
      "provider": "openAI",
      "modelName": "gpt-4o-mini",
      "modelKey": "uuid-generated-key",
      "isMultimodal": false,
      "isDefault": false
    }
  ],
  "message": "Found 2 llm models"
}

AI Model Provider Management

CRUD operations for individual AI model providers.

POST /ai-models/providers - Add AI Model Provider

Request
Response

Endpoint: POST /api/v1/configurationManager/ai-models/providersRequest Body Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal
provider	string	Yes	Provider name (e.g., openAI, anthropic, cohere)
configuration	object	Yes	Provider-specific configuration
isMultimodal	boolean	No	Whether model supports multimodal input (default: false)
isDefault	boolean	No	Whether this should be the default model (default: false)

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

Status: 200 OK

{
  "status": "success",
  "message": "LLM provider added successfully",
  "details": {
    "modelKey": "uuid-generated-key",
    "modelType": "llm",
    "provider": "anthropic",
    "model": "claude-3-opus",
    "isDefault": false
  }
}

PUT /ai-models/providers/{modelType}/{modelKey} - Update AI Model Provider

Request
Response

Endpoint: PUT /api/v1/configurationManager/ai-models/providers/{modelType}/{modelKey}Path Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal
modelKey	string	Yes	Unique key for the model configuration

Request Body Parameters:

Parameter	Type	Required	Description
provider	string	Yes	Provider name
configuration	object	Yes	Provider-specific configuration
isMultimodal	boolean	No	Whether model supports multimodal input (default: false)
isDefault	boolean	No	Whether this should be the default model (default: false)

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

Status: 200 OK

{
  "status": "success",
  "message": "LLM provider updated successfully",
  "details": {
    "modelKey": "uuid-generated-key",
    "modelType": "llm",
    "provider": "anthropic",
    "model": "claude-3-sonnet"
  }
}

DELETE /ai-models/providers/{modelType}/{modelKey} - Delete AI Model Provider

Request
Response

Endpoint: DELETE /api/v1/configurationManager/ai-models/providers/{modelType}/{modelKey}Path Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal
modelKey	string	Yes	Unique key for the model configuration

Status: 200 OK

{
  "status": "success",
  "message": "LLM provider deleted successfully",
  "details": {
    "modelKey": "uuid-generated-key",
    "modelType": "llm",
    "provider": "anthropic",
    "model": "claude-3-opus",
    "wasDefault": false
  }
}

PUT /ai-models/default/{modelType}/{modelKey} - Update Default AI Model

Request
Response

Endpoint: PUT /api/v1/configurationManager/ai-models/default/{modelType}/{modelKey}Path Parameters:

Parameter	Type	Required	Description
modelType	string	Yes	One of: llm, embedding, ocr, slm, reasoning, multiModal
modelKey	string	Yes	Unique key for the model configuration

Status: 200 OK

{
  "status": "success",
  "message": "Default llm model updated successfully",
  "details": {
    "modelKey": "uuid-generated-key",
    "modelType": "llm",
    "provider": "anthropic",
    "model": "claude-3-opus"
  }
}

Connector Configuration

Configure connectors for integrating with external services.

Google Workspace Configuration

Configure Google Workspace integration settings.

Google Workspace OAuth Configuration

POST /connectors/googleWorkspaceOauthConfig - Set Google Workspace OAuth Config

Request
Response

Endpoint: POST /api/v1/configurationManager/connectors/googleWorkspaceOauthConfigRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Google client ID
clientSecret	string	Yes	Google client secret
enableRealTimeUpdates	boolean/string	No	Enable real-time updates
topicName	string	No	Pub/Sub topic name (required if enableRealTimeUpdates is true)

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

Status: 200 OK

{
  "message": "Google Workspace credentials created successfully"
}

GET /connectors/googleWorkspaceOauthConfig - Get Google Workspace OAuth Config

Request
Response

Endpoint: GET /api/v1/configurationManager/connectors/googleWorkspaceOauthConfig

Status: 200 OK

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

Google Workspace Credentials

POST /connectors/googleWorkspaceCredentials - Set Google Workspace Credentials

Request
Response

Endpoint: POST /api/v1/configurationManager/connectors/googleWorkspaceCredentialsContent-Type: multipart/form-dataRequest Body Parameters:

Parameter	Type	Required	Description
googleWorkspaceCredentials	file	No	JSON file with credentials (for business accounts)
userType	string	No	”individual” or “business”
fileChanged	boolean	No	Whether the file was changed (for business accounts)
adminEmail	string	Conditional	Required for business accounts
enableRealTimeUpdates	boolean/string	No	Enable real-time updates
topicName	string	No	Pub/Sub topic name (required if enableRealTimeUpdates is true)

For individual accounts, you can also send credentials directly in the request body:

{
  "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"
}

Status: 200 OK

{
  "message": "Successfully updated"
}

GET /connectors/googleWorkspaceCredentials - Get Google Workspace Credentials

Request
Response

Endpoint: GET /api/v1/configurationManager/connectors/googleWorkspaceCredentials

Status: 200 OKIndividual Account Response:

{
  "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-google-client-id",
  "clientSecret": "your-google-client-secret"
}

Business Account Response:

{
  "type": "service_account",
  "project_id": "your-project-id",
  "private_key_id": "your-private-key-id",
  "private_key": "-----BEGIN PRIVATE KEY-----\n...\n-----END PRIVATE KEY-----\n",
  "client_email": "service-account@project.iam.gserviceaccount.com",
  "client_id": "your-client-id",
  "auth_uri": "https://accounts.google.com/o/oauth2/auth",
  "token_uri": "https://oauth2.googleapis.com/token",
  "auth_provider_x509_cert_url": "https://www.googleapis.com/oauth2/v1/certs",
  "client_x509_cert_url": "https://www.googleapis.com/robot/v1/metadata/x509/...",
  "universe_domain": "googleapis.com",
  "adminEmail": "admin@example.com",
  "enableRealTimeUpdates": true,
  "topicName": "gmail-updates"
}

Atlassian Configuration

Configure Atlassian integration.

POST /connectors/atlassian/config - Set Atlassian Config

Request
Response

Endpoint: POST /api/v1/configurationManager/connectors/atlassian/configRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Atlassian client ID
clientSecret	string	Yes	Atlassian client secret

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

Status: 200 OK

{
  "message": "Atlassian config created successfully"
}

GET /connectors/atlassian/config - Get Atlassian Config

Request
Response

Endpoint: GET /api/v1/configurationManager/connectors/atlassian/config

Status: 200 OK

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

OneDrive Configuration

Configure Microsoft OneDrive integration.

POST /connectors/onedrive/config - Set OneDrive Config

Request
Response

Endpoint: POST /api/v1/configurationManager/connectors/onedrive/configRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Microsoft client ID
clientSecret	string	Yes	Microsoft client secret
tenantId	string	Yes	Microsoft tenant ID
hasAdminConsent	boolean	No	Whether admin consent has been granted

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

Status: 200 OK

{
  "message": "OneDrive credentials created successfully"
}

GET /connectors/onedrive/config - Get OneDrive Config

Request
Response

Endpoint: GET /api/v1/configurationManager/connectors/onedrive/config

Status: 200 OK

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

SharePoint Configuration

Configure Microsoft SharePoint integration.

POST /connectors/sharepoint/config - Set SharePoint Config

Request
Response

Endpoint: POST /api/v1/configurationManager/connectors/sharepoint/configRequest Body Parameters:

Parameter	Type	Required	Description
clientId	string	Yes	Microsoft client ID
clientSecret	string	Yes	Microsoft client secret
tenantId	string	Yes	Microsoft tenant ID
sharepointDomain	string	Yes	SharePoint domain
hasAdminConsent	boolean	No	Whether admin consent has been granted

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

Status: 200 OK

{
  "message": "SharePoint credentials created successfully"
}

GET /connectors/sharepoint/config - Get SharePoint Config

Request
Response

Endpoint: GET /api/v1/configurationManager/connectors/sharepoint/config

Status: 200 OK

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

Public URL Configuration

Configure public URLs for frontend and connector services.

Frontend URL Configuration

POST /frontendPublicUrl - Set Frontend URL

Request
Response

Endpoint: POST /api/v1/configurationManager/frontendPublicUrlRequest Body Parameters:

Parameter	Type	Required	Description
url	string	Yes	Public URL for frontend service

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

Status: 200 OK

{
  "message": "Frontend Url saved successfully"
}

GET /frontendPublicUrl - Get Frontend URL

Request
Response

Endpoint: GET /api/v1/configurationManager/frontendPublicUrl

Status: 200 OK

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

Connector URL Configuration

POST /connectorPublicUrl - Set Connector URL

Request
Response

Endpoint: POST /api/v1/configurationManager/connectorPublicUrlRequest Body Parameters:

Parameter	Type	Required	Description
url	string	Yes	Public URL for connector service

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

Status: 200 OK

{
  "message": "Connector Url saved successfully"
}

GET /connectorPublicUrl - Get Connector URL

Request
Response

Endpoint: GET /api/v1/configurationManager/connectorPublicUrl

Status: 200 OK

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

Metrics Collection Configuration

Configure metrics collection settings for monitoring and analytics.

PUT /metricsCollection/toggle - Toggle Metrics Collection

Request
Response

Endpoint: PUT /api/v1/configurationManager/metricsCollection/toggleRequest Body Parameters:

Parameter	Type	Required	Description
enableMetricCollection	boolean	Yes	Enable or disable metrics collection

{
  "enableMetricCollection": true
}

Status: 200 OK

{
  "message": "Metrics collection toggled successfully"
}

GET /metricsCollection - Get Metrics Collection Config

Request
Response

Endpoint: GET /api/v1/configurationManager/metricsCollection

Status: 200 OK

{
  "enableMetricCollection": "true",
  "pushIntervalMs": "30000",
  "serverUrl": "https://metrics.example.com"
}

PATCH /metricsCollection/pushInterval - Set Push Interval

Request
Response

Endpoint: PATCH /api/v1/configurationManager/metricsCollection/pushIntervalRequest Body Parameters:

Parameter	Type	Required	Description
pushIntervalMs	number	Yes	Push interval in milliseconds

{
  "pushIntervalMs": 30000
}

Status: 200 OK

{
  "message": "Metrics collection push interval set successfully"
}

PATCH /metricsCollection/serverUrl - Set Remote Server

Request
Response

Endpoint: PATCH /api/v1/configurationManager/metricsCollection/serverUrlRequest Body Parameters:

Parameter	Type	Required	Description
serverUrl	string	Yes	Remote metrics server URL

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

Status: 200 OK

{
  "message": "Metrics collection remote server set successfully"
}

Encryption and Security

The Configuration Manager Service uses AES-256-GCM encryption to protect sensitive configuration data. Key features include:

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

The Configuration Manager publishes events when critical configurations change:

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

These events allow other services to react to configuration changes without polling.

Health Checks

The service includes built-in health checks for various configurations that are automatically performed before saving:

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;
}

// S3 Storage Config
interface S3Config {
  storageType: "s3";
  s3AccessKeyId: string;
  s3SecretAccessKey: string;
  s3Region: string;
  s3BucketName: string;
}

// Azure Blob Storage Config (Connection String)
interface AzureBlobConfigConnectionString {
  storageType: "azureBlob";
  azureBlobConnectionString: string;
  containerName: string;
}

// Azure Blob Storage Config (Individual Parameters)
interface AzureBlobConfigParameters {
  storageType: "azureBlob";
  accountName: string;
  accountKey: string;
  containerName: string;
  endpointProtocol?: "http" | "https"; // defaults to "https"
  endpointSuffix?: string; // defaults to "core.windows.net"
}

// Local Storage Config
interface LocalConfig {
  storageType: "local";
  mountName?: string;
  baseUrl?: string;
}

// MongoDB Config
interface MongoDBConfig {
  uri: string; // MongoDB connection URI
  db: string; // Database name (automatically set to "pipesHub")
}

// ArangoDB Config
interface ArangoDBConfig {
  url: string;
  username?: string;
  password?: string;
  db: string; // Database name (automatically set to "pipesHub")
}

// Qdrant Config
interface QdrantConfig {
  host: string;
  port: number;
  grpcPort?: number;
  apiKey?: string; // Not required for localhost
}

// Redis Config
interface RedisConfig {
  host: string;
  port: number;
  password?: string;
  tls?: boolean;
}

// AI Model Configuration
interface ModelConfiguration {
  model?: string; // Can be comma-separated for multiple models
  apiKey?: string;
  endpoint?: string;
  organizationId?: string;
  deploymentName?: string;
  provider?: string;
  awsAccessKeyId?: string;
  awsAccessSecretKey?: string;
  region?: string;
  model_kwargs?: Record<string, any>;
  encode_kwargs?: Record<string, any>;
  cache_folder?: string;
}

// AI Model Provider
interface ModelProvider {
  provider: string; // Provider name (openAI, anthropic, cohere, etc.)
  configuration: ModelConfiguration;
  modelKey: string; // Auto-generated UUID
  isMultimodal: boolean;
  isDefault: boolean;
}

// Complete AI Models Config
interface AIModelsConfig {
  ocr?: ModelProvider[];
  embedding?: ModelProvider[];
  slm?: ModelProvider[];
  llm?: ModelProvider[];
  reasoning?: ModelProvider[];
  multiModal?: ModelProvider[];
}

// Available Model Types
type ModelType = "llm" | "embedding" | "ocr" | "slm" | "reasoning" | "multiModal";

// Supported Providers
type EmbeddingProvider = "anthropic" | "bedrock" | "azureOpenAI" | "cohere" | "default" | 
  "fireworks" | "gemini" | "huggingFace" | "jinaAI" | "mistral" | "ollama" | "openAI" | 
  "openAICompatible" | "sentenceTransformers" | "together" | "vertexAI" | "voyage";

type LLMProvider = "anthropic" | "bedrock" | "azureOpenAI" | "cohere" | "fireworks" | 
  "gemini" | "groq" | "mistral" | "ollama" | "openAI" | "openAICompatible" | "together" | 
  "vertexAI" | "xai";

// Google Workspace Individual Credentials
interface GoogleWorkspaceIndividualCredentials {
  access_token: string;
  refresh_token: string;
  access_token_expiry_time: number;
  refresh_token_expiry_time?: number;
  enableRealTimeUpdates: boolean;
  topicName: string;
}

// Google Workspace Business Credentials
interface GoogleWorkspaceBusinessCredentials {
  type: string;
  project_id: string;
  private_key_id: string;
  private_key: string;
  client_email: string;
  client_id: string;
  auth_uri: string;
  token_uri: string;
  auth_provider_x509_cert_url: string;
  client_x509_cert_url: string;
  universe_domain: string;
  adminEmail: string;
  enableRealTimeUpdates: boolean;
  topicName: string;
}

// Google Workspace OAuth Config
interface GoogleWorkspaceOAuthConfig {
  clientId: string;
  clientSecret: string;
  enableRealTimeUpdates: boolean;
  topicName: string;
}

// Atlassian Config
interface AtlassianConfig {
  clientId: string;
  clientSecret: string;
}

// OneDrive Config
interface OneDriveConfig {
  clientId: string;
  clientSecret: string;
  tenantId: string;
  hasAdminConsent?: boolean;
}

// SharePoint Config
interface SharePointConfig {
  clientId: string;
  clientSecret: string;
  tenantId: string;
  sharepointDomain: string;
  hasAdminConsent?: boolean;
}

// Message Broker Config
interface KafkaConfig {
  brokers: string[]; // Array of broker URLs
  sasl?: {
    mechanism: string;
    username: string;
    password: string;
  };
}

// SMTP Config
interface SMTPConfig {
  host: string;
  port: number;
  username?: string;
  password?: string;
  fromEmail: string;
}

// Metrics Collection Config
interface MetricsConfig {
  enableMetricCollection: string; // "true" or "false"
  pushIntervalMs?: string; // Interval in milliseconds as string
  serverUrl?: string; // Remote metrics server URL
}

Welcome To PipesHub

System Overview

Authentication

Mail Configuration

AI Providers

Connectors

Integrations

Agents

Toolsets

MCP Server

User Management

Deployment

Developer

Additional Resources

Configuration manager

Configuration Manager API

Base URL

Authentication

Architecture Overview

Key Features

Supported Configurations

API Endpoints

Encryption and Security

Event-Driven Architecture

Health Checks

Schema Definitions

​Configuration Manager API

​Base URL

​Authentication

​Architecture Overview

​Key Features

​Supported Configurations

​API Endpoints

​Encryption and Security

​Event-Driven Architecture

​Health Checks

​Schema Definitions

Configuration Manager API

Base URL

Authentication

Architecture Overview

Key Features

Supported Configurations

API Endpoints

Encryption and Security

Event-Driven Architecture

Health Checks

Schema Definitions