--- title: "Configure pipeline components" method: POST path: "/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration" tags: ["Build and Configure Continuous Integration Projects"] --- # Configure pipeline components `POST /v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration` ## Request - Base URL: `https://integration-adapter.connect.cloud.precisely.com` - URL: `https://integration-adapter.connect.cloud.precisely.com/v1/integration/continuous/projects/{projectId}/pipelines/{pipelineId}/configuration` - Auth: HTTP bearer Creates configuration for various components within a specific pipeline in a project. **Process Overview:** 1. **Resource Validation** - Validates project and pipeline existence 2. **Parallel Component Processing** - Processes each component configuration independently 3. **Component Types Supported**: - **Metabase**: Replication Metadata configuration - **LogReader**: Log processing and journal management - **UserDatabase**: User data store configuration - **Staging**: Data staging and batch processing configuration 4. **Isolation & Fault Tolerance** - Component failures don't affect others 5. **Component Existence & Skipping:** - If a component is already configured and up-to-date, its configuration step is skipped. 6. **Consolidated Response** - Returns unified status after all processing **Key Features:** - All component configurations are optional - Parallel processing for optimal performance - Independent component execution (failure isolation) - Metrics per component for better observability - Component specific thread pool resource allocation - Comprehensive error reporting per component **Required Permissions:** Either `replication-pipeline::create` or `replication-pipeline::update` when permission harmonization is enabled; otherwise, `replication-pipeline::manage`. ## Path parameters - `projectId` string, required - `pipelineId` string, required ## Request body - ContinuousPipelineConfigurationRequest: Request payload for configuring various components within a continuous integration pipeline - `metabase` MetabaseConfiguration: Composite Metabase configuration containing source and target endpoint configurations - `source` MetabaseEndpointConfiguration: Configuration parameters for a single Metabase endpoint (source or target) - `name` string, required: The name identifier for the Metabase instance - `vaultConnectionId` string: Vault connection ID for secure credential storage - `adminUser` string: Admin username for Metabase authentication - `adminPassword` string: Admin password for Metabase authentication - `replicationUser` string, required: Replication user for Metabase - `replicationPassword` string, required: Password for Metabase replication user - `parameters` object: Additional configuration parameters - `role` 'SOURCE' | 'TARGET': Endpoint role (SOURCE or TARGET) - `target` MetabaseEndpointConfiguration: Configuration parameters for a single Metabase endpoint (source or target) - `name` string, required: The name identifier for the Metabase instance - `vaultConnectionId` string: Vault connection ID for secure credential storage - `adminUser` string: Admin username for Metabase authentication - `adminPassword` string: Admin password for Metabase authentication - `replicationUser` string, required: Replication user for Metabase - `replicationPassword` string, required: Password for Metabase replication user - `parameters` object: Additional configuration parameters - `role` 'SOURCE' | 'TARGET': Endpoint role (SOURCE or TARGET) - `logReader` LogReaderConfiguration: Configuration parameters for LogReader log processing and journal management component - `name` string, required: The name identifier for the LogReader instance - `journalName` string: The journal name for log processing and change data capture, mandatory for DB2I connection type but can be omitted for Db2LUW connection type - `parameters` object: Additional configuration parameters for LogReader customization - `userDatabase` UserDatabaseConfiguration: Composite User Database configuration containing source and target endpoint configurations - `source` UserDatabaseEndpointConfiguration: Configuration parameters for creating User Databases per endpoint (source or target) - `databases` string[], required: List of user databases to configure - `vaultConnectionId` string: Vault connection ID for secure credential storage - `username` string, required: Username for user database authentication - `password` string, required: Password for user database authentication - `replicationUser` string: Replication user for the prepared user databases; required for SQL Server and PostgreSQL connections - `role` 'SOURCE' | 'TARGET': Endpoint role (SOURCE or TARGET) - `target` UserDatabaseEndpointConfiguration: Configuration parameters for creating User Databases per endpoint (source or target) - `databases` string[], required: List of user databases to configure - `vaultConnectionId` string: Vault connection ID for secure credential storage - `username` string, required: Username for user database authentication - `password` string, required: Password for user database authentication - `replicationUser` string: Replication user for the prepared user databases; required for SQL Server and PostgreSQL connections - `role` 'SOURCE' | 'TARGET': Endpoint role (SOURCE or TARGET) - `staging` StagingConfiguration: Configuration parameters for Staging data processing and batch management component - `type` 'CDWH_STAGING_TYPE_GCS' | 'CDWH_STAGING_TYPE_S3' | 'CDWH_STAGING_TYPE_AZURE', required: Type of staging configuration specifying the cloud storage platform - `directory` string, required: Directory path for staging data storage - `schema` string, required: Database schema name for staging operations - `vaultConnectionId` string: Vault connection ID for secure credential storage - `storageIntegration` string: Name of the Snowflake account-level object for connecting to external cloud storage (used for Snowflake target connections with GCP/Azure/S3 staging) - `batchWindow` BatchWindow, required: Configuration for batch processing windows in staging operations. Defines both data volume and time-based triggers that determine when batch processing operations should be initiated in the staging environment. - `data` DataLimit: Configuration for data limits in batch operations - `limit` integer, required: Numeric limit value for batch processing - `units` string, required: Units for the data limit - `duration` Duration: Configuration for duration limits in batch operations - `frequency` integer, required: Frequency value for batch processing - `units` string, required: Time units for the frequency ## Response `201` Configuration successfully applied to pipeline components - ContinuousPipelineConfigurationResponse: Consolidated response containing results from continuous pipeline component configuration operations - `requestId` string: Unique identifier for this configuration request - `overallStatus` 'SUCCESS' | 'PARTIAL' | 'FAILED': Overall status of the configuration operation - `executionTimeInMs` integer: Total execution time for all component configurations in milliseconds - `metabase` MetabaseResult: Metabase configuration outcome separated into success and failure lists - `source` MetabaseConfigurationResult: Individual Metabase configuration result - `name` string: Name of the Metabase endpoint instance - `version` string: Version of the Metabase instance (if created) - `response` string: Response / status message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Status for this endpoint configuration - `target` MetabaseConfigurationResult: Individual Metabase configuration result - `name` string: Name of the Metabase endpoint instance - `version` string: Version of the Metabase instance (if created) - `response` string: Response / status message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Status for this endpoint configuration - `logReader` LogReaderResult: Result details for LogReader component configuration - `name` string: Name of the configured LogReader instance - `journalName` string: Journal name associated with the LogReader - `response` string: Response message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for this component - `userDatabase` UserDatabaseResult: Result details for User Database component configurations - `source` EndpointUserDatabaseResult: Aggregated database configuration results for one endpoint (source or target) - `success` DatabaseConfigurationResult[]: Successful database configuration results for this endpoint - `name` string: Name of the user database - `response` string: Response message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for this user database - `failure` DatabaseConfigurationResult[]: Failed database configuration results for this endpoint - `name` string: Name of the user database - `response` string: Response message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for this user database - `target` EndpointUserDatabaseResult: Aggregated database configuration results for one endpoint (source or target) - `success` DatabaseConfigurationResult[]: Successful database configuration results for this endpoint - `name` string: Name of the user database - `response` string: Response message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for this user database - `failure` DatabaseConfigurationResult[]: Failed database configuration results for this endpoint - `name` string: Name of the user database - `response` string: Response message from the configuration process - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for this user database - `staging` StagingResult: Result details for Staging component configuration - `status` 'SUCCESS' | 'FAILED' | 'SKIPPED': Configuration status for staging component - `response` string: Response message from the configuration process ## Other responses - `400`: Bad Request - Validation failed due to one of the following reasons: - Invalid project ID - Invalid pipeline ID - Invalid component configuration parameters - Missing required configuration fields - Invalid parameters for metabase configuration - Invalid batch window or staging parameters - Invalid username or password - Missing data connection IDs - `401`: Unauthorized - Authentication required, valid credentials not provided - `403`: Forbidden - User lacks 'replication-pipeline::create' or 'replication-pipeline::update' when permission harmonization is enabled, or legacy 'replication-pipeline::manage' otherwise - `404`: Not Found - Resource not found: - Project with specified ID does not exist - Pipeline with specified ID does not exist in the project - Data connection referenced in configuration not found - `422`: Unprocessable Entity - Configuration conflicts or business rule violations: - Component configuration conflicts with existing pipeline settings - Invalid combination of component configurations - Resource capacity constraints exceeded - Invalid data connection types for specified components - Authentication failures with provided credentials - `500`: Internal Server Error - Component processing failures: - Metabase service configuration failures - LogReader service configuration failures - UserDatabase provisioning errors - Staging configuration setup failures - Thread pool execution errors - Internal processing errors --- [API](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service.md) · [All operations](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/llms.txt) · [OpenAPI document](https://skmtc.dev/precisely/apis/precisely-integration-adapter-service/revisions/2d2629f4987d?raw)