Monitoring APIs provide operational visibility into project and pipeline health, latency, backlog, table-level statistics, and alerts. They enable triggering lifecycle actions (start/stop) for pipelines, bulk or targeted, and provide monitoring endpoints for asynchronous operations.
Methods
- GET Get project status
-
Retrieves the status of all pipelines within a specified project. If a
pipelineIdis supplied the scope is narrowed to that pipeline. Optionally include detailed table statistics. - GET Get project alerts
- Fetches alerts for a specified project, with optional filtering by server name and severity level.
- POST Trigger pipelines
- Submits an asynchronous lifecycle action (START or STOP) for one or more continuous replication pipelines in a project.
- POST Trigger start/stop actions for specified log reader
- Submits an asynchronous lifecycle action (START, STOP) for log reader associated with pipeline within the specified project.
- POST Trigger start/stop actions for capture
- Submits an asynchronous lifecycle action (START or STOP) for capture operations on all or specified table identifiers in a pipeline.
- POST Trigger start/stop actions for runtime engines
- Submits an asynchronous lifecycle action (START or STOP) for one or more continuous replication runtime engines in a project.
- POST Trigger clear operation for backlog rows
- Submits an asynchronous clear operation for backlog rows associated with a pipeline in a project.
- POST Trigger diagnostic bundle operations
- Submits a request to start or stop diagnostic bundles.
- GET Get diagnostic bundle statuses
- Retrieves the statuses of diagnostic bundles for the specified project.
- DELETE Delete a diagnostic bundle
- Deletes a diagnostic bundle by its ID for the specified project.