Retrieves the status of all pipelines within a specified project. If a pipelineId is supplied the scope is narrowed to that pipeline. Optionally include detailed table statistics.
Process overview
- Validate the caller has view permission.
- Fetch project and pipelines; optionally filter.
- Optionally enrich with table detail if requested.
Key features
- Lightweight by default (table details off).
- Supports targeted lookup by
pipelineId.
Required permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project. |
Query parameters
| Key | Required | Type | Description |
|---|---|---|---|
| pipelineId | No | string |
Unique identifier of the pipeline within the project, if you want status for a specific pipeline. |
| includeTableDetails | No | boolean |
Include detailed table status information. If not provided, defaults to false. |
Response
Response body properties
| Ancestors | Property | Required | Type | Description | |
|---|---|---|---|---|---|
| content | No | array[object] | List of projects in the current page. | ||
| content | id | No | string | Unique identifier of the project. | |
| content | name | No | string | Name of the project. | |
| content | description | No | string | Description of the project. | |
| content | projectType | No | string | Type of the project (for example, COPY, REPLICATION, MAINFRAME_REPLICATION). | |
| content | createdAt | No | string | Timestamp when the project was created. | |
| content | createdBy | No | string | Username of the person who created the project. | |
| content | modifiedAt | No | string | Timestamp when the project was last modified. | |
| content | modifiedBy | No | string | Username of the person who last modified the project. | |
| content | committedAt | No | string | Timestamp when the project was last committed. | |
| content | committedBy | No | string | Username of the person who committed the project. | |
| content | deployedAt | No | string | Timestamp when the project was last deployed. | |
| content | deployedBy | No | string | Username of the person who deployed the project. | |
| content | parameters | No | object[string] | Configuration parameters for the project. | |
| content | pipelines | No | array[object] | List of Pipelines associated with this project. | |
| content/pipelines | id | No | string | Unique identifier of the pipeline. | |
| content/pipelines | name | No | string | Name of the pipeline. | |
| content/pipelines | description | No | string | Description of the pipeline. | |
| content/pipelines | pipelineType | No | string | Type of the pipeline (for example, COPY, REPLICATE, SYNCHRONIZE). |
|
| content/pipelines | projectId | No | string | Unique identifier of the project containing this pipeline. | |
| content/pipelines | sourceConnectionId | No | string | Unique identifier of the source data connection. | |
| content/pipelines | sourceParameters | No | object[string] | Configuration parameters for the source connection. | |
| content/pipelines | targetConnectionId | No | string | Unique identifier of the target data connection. | |
| content/pipelines | targetParameters | No | object[string] | Configuration parameters for the target connection. | |
| content/pipelines | schemaRegistryId | No | string | Identifier of the schema registry. | |
| content/pipelines | includedCDCRowMetadata | No | array[string] | Metadata fields to include with change data records for all default table mappings in this pipeline. | |
| content/pipelines | createdAt | No | string | Timestamp when the pipeline was created. | |
| content/pipelines | properties | No | object[string] | Additional configuration properties for the pipeline. | |
| content/pipelines | createdBy | No | string | Username of the pipeline owner. | |
| content/pipelines | modifiedAt | No | string | Timestamp when the pipeline was last modified. | |
| content/pipelines | modifiedBy | No | string | Username of the person who last modified the pipeline. | |
| content/pipelines | tableMappings | No | array[object] | List of table mappings configured for this pipeline. | |
| content/pipelines/tableMappings | sourceDatabase | No | string | Name of the source database. | |
| content/pipelines/tableMappings | sourceSchema | No | string | Name of the source schema. | |
| content/pipelines/tableMappings | sourceTable | No | string | Name of the source table. | |
| content/pipelines/tableMappings | targetDatabase | No | string | Name of the target database. | |
| content/pipelines/tableMappings | targetSchema | No | string | Name of the target schema. | |
| content/pipelines/tableMappings | targetTable | No | string | Name of the target table. | |
| content/pipelines/tableMappings | targetTopic | No | string | Name of the target topic. | |
| content/pipelines/tableMappings | targetSubject | No | string | Name of the target subject for schema registry. | |
| content/pipelines/tableMappings | type | No | string | Type of the table mapping. | |
| content/pipelines/tableMappings | hasCustomColMappings | No | boolean | Flag indicating whether the table has custom column mappings. | |
| content/pipelines/tableMappings | includedCDCRowMetadata | No | array[string] | Metadata fields to include with change data records for this table mapping configuration, this overrides the Metadata fields defined at the pipeline level. | |
| content/pipelines/tableMappings | schemaVersion | No | string | Version of the schema used for this mapping. | |
| content/pipelines/tableMappings | softDeleteColumnName | No | string | Name of the column used for soft deletes. | |
| content/pipelines/tableMappings | columnMappings | No | array[object] | List of column mappings for this table. | |
| pageNumber | No | integer | Zero-based page number. | ||
| pageSize | No | integer | Number of items per page (requested size). | ||
| numberOfElements | No | integer | Actual number of projects in the current page. | ||
| totalElements | No | integer | Total number of projects across all pages. | ||
| totalPages | No | integer | Total number of pages available. | ||
| first | No | boolean | Indicates if this is the first page. | ||
| last | No | boolean | Indicates if this is the last page. |
Response examples
{
"name": "string",
"agentId": "string",
"virtualId": "string",
"projectId": "string",
"changeStatus": "UP_TO_DATE",
"generatedAt": "string",
"serverVersions": [
{
"server": "string",
"committedVersion": 0,
"deployedVersion": 0
}
],
"projectStatus": {
"overallStatus": "OK",
"runtimeServerStatus": "OK",
"replicationStatus": "OK",
"logReaderStatus": "OK",
"captureStatus": "OK"
},
"pipelines": [
{
"name": "string",
"pipelineType": "SYNCHRONIZE",
"runtimeServerStatus": "",
"replicationStatus": "",
"captureStatus": "",
"logReaderStatus": "",
"overallStatus": "",
"currentPhase": "UNKNOWN",
"startedAt": "string",
"backlog": {
"rows": 0,
"transactions": 0,
"reportedAt": "string"
},
"stats": {
"retrieved": {
"bytes": 0,
"rows": 0,
"skippedRows": 0,
"transactions": 0,
"reportedAt": "string"
},
"sent": {
"bytes": 0,
"rows": 0,
"skippedRows": 0,
"transactions": 0,
"reportedAt": "string"
},
"applied": {
"bytes": 0,
"rows": 0,
"skippedRows": 0,
"transactions": 0,
"reportedAt": "string"
},
"averageLatency": {
"backlog": 0,
"capture": 0,
"replication": 0,
"total": 0,
"updatedAt": "string"
},
"backlogLatency": 0,
"captureLatency": 0,
"replicationLatency": 0,
"totalLatency": 0,
"statisticEstimationWindow": "string"
},
"tableLevelStats": [
{
"stats": {
"applied": {
"bytes": 0,
"transactions": 0,
"recordCount": 0,
"stagedRecordCount": 0,
"insertRecordCount": 0,
"updateRecordCount": 0,
"deleteRecordCount": 0,
"skippedRecordBytes": 0,
"skippedRecordCount": 0,
"skippedInsertRecordCount": 0,
"skippedUpdateRecordCount": 0,
"skippedDeleteRecordCount": 0
},
"retrieved": {
"bytes": 0,
"transactions": 0,
"recordCount": 0,
"stagedRecordCount": 0,
"insertRecordCount": 0,
"updateRecordCount": 0,
"deleteRecordCount": 0,
"skippedRecordBytes": 0,
"skippedRecordCount": 0,
"skippedInsertRecordCount": 0,
"skippedUpdateRecordCount": 0,
"skippedDeleteRecordCount": 0
},
"sent": {
"bytes": 0,
"transactions": 0,
"recordCount": 0,
"stagedRecordCount": 0,
"insertRecordCount": 0,
"updateRecordCount": 0,
"deleteRecordCount": 0,
"skippedRecordBytes": 0,
"skippedRecordCount": 0,
"skippedInsertRecordCount": 0,
"skippedUpdateRecordCount": 0,
"skippedDeleteRecordCount": 0
}
},
"source": {
"database": "string",
"schema": "string",
"table": "string"
},
"target": {
"database": "string",
"schema": "string",
"table": "string"
}
}
]
}
]
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0000"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": 400,
"detail": "Validation error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0000"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": 403,
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0002"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.5",
"title": "Not Found",
"status": 404,
"detail": "Not Found - Resource does not exist",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-STA-0002"
}
}{
"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.6",
"title": "Internal Server Error",
"status": 500,
"detail": "An unexpected error occurred",
"instance": "/v1/integration/continuous/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-STA-0001"
}
}