These configuration APIs enable programmatic creation and management of continuous integration projects, pipelines, component configurations (metabase, log reader, staging, user databases), and table mappings. They support both synchronous and asynchronous operations with validation, parallel component processing, and detailed error reporting.
Methods
- GET Get projects
- Retrieves a paginated list of continuous data integration projects with optional filtering and sorting.
- GET Get project by ID
- Retrieves a specific continuous data integration project by its unique identifier.
- DELETE Delete a project by ID
- Deletes a project by its ID. Supports optional deletion of project configuration only.
- GET Get project deletion status
- Retrieves the deletion status of a project.
- GET Get pipelines for a project
- Retrieves all continuous data integration pipelines associated with a specific project with pagination and sorting.
- GET Get pipeline by ID
- Retrieves a specific continuous data integration pipeline by its unique identifier.
- DELETE Delete pipeline by ID
- Deletes a pipeline by its ID within a project.
- GET Get pipeline deletion status by ID
- Retrieves the deletion status of a pipeline within a project.
- POST Create project and pipeline
- Creates a new continuous data integration pipeline with specified configuration parameters.
- POST Associate connections with pipeline
- Associates source and target connections with an existing continuous pipeline.
- GET Get metabases for a connection
- Retrieves metabase configuration associated with a specific data connection inside a project.
- GET Get journals for a connection
- Retrieves the list of available journals for a specific data connection inside a project.
- GET Get log readers for a connection
- Retrieves LogReader configurations associated with a specific data connection inside a project.
- POST Configure pipeline components
- Creates configuration for various components within a specific pipeline in a project.
- POST Suggest source assets
- Suggests source assets (DATABASE, SCHEMA, TABLE, TOPIC, KAFKA_SCHEMA) matching the provided search patterns for a pipeline.
- POST Configure table mappings for a pipeline
- Configures source-to-target table mappings for a specified pipeline within a continuous integration project.
- POST Create a target dataset for a pipeline
- Creates a target dataset for a specified pipeline.
- GET Get database creation status
- Fetches the status of an asynchronous target dataset creation task for the specified pipeline.
- POST Create a new project
- Creates a new continuous data integration project with the specified name and parameters.
- POST Activate a project
- Stages and optionally activates a project, with optional pipeline start.
- GET Get project staging status
- Retrieves the staging status of a project.