Retrieves the status of mainframe pipelines within a specified project.
If a pipelineId is supplied the scope is narrowed to that pipeline. Optionally include latency details.
Process Overview
- Fetch project and associated pipelines status.
- Filter by pipelineId if provided.
- Optionally enrich with latency detail if requested.
Key Features
- Lightweight by default (latency details off).
- Supports targeted lookup via 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. |
| includeLatency | No | boolean | Include latency details. If not provided, defaults to false. |
Response
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| tenantId | No | string | |
| projectId | No | string | |
| reportedAt | No | string |
|
| pipelines | No | array |
Response examples
Example status code responses for this method are shown here.
"tenantId": "hdncngclqxsdfzcwf",
"projectId": "69036d04872fd75c7ad2596e",
"reportedAt": "2025-01-01T00:00:00Z",
"pipelines": [
{
"pipelineId": "69036d1e872fd75c7ad2596f",
"name": "KafkaToDB2i",
"runtimeServers": [
MainframeEngine
]
"status": "RUNNING",
"startedAt": "2025-01-01T00:00:00Z",
"stats": {
"captured": {
"rows": "1000",
"bytes": "50000",
"transactions": "500",
"reportedAt": "2025-01-01T00:00:00Z"
}
"applied": {
"rows": "1000",
"bytes": "50000",
"transactions": "500",
"reportedAt": "2025-01-01T00:00:00Z"
}
}
"latency": {
"current": {
"capture": "10",
"backlog": "5",
"apply": "15",
"reportedAt": "2025-01-01T00:00:00Z"
}
"average": {
"capture": "12",
"backlog": "6",
"apply": "18",
"estimationWindow": "1",
"reportedAt": "2025-01-01T00:00:00Z"
}
}
}
]"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.1",
"title": "Bad Request",
"status": "400",
"detail": "Validation error occurred",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-VAL-0000"
}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.2",
"title": "Unauthorized",
"status": "401",
"detail": "Authorization failed - missing or invalid credentials",
"instance": "/v1/integration/mainframe/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-AUT-0001"
}"type": "https://datatracker.ietf.org/doc/html/rfc9110#section-15.5.4",
"title": "Forbidden",
"status": "403",
"detail": "Authorization failed - insufficient permissions",
"instance": "/v1/integration/mainframe/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/mainframe/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/mainframe/monitoring/projects/{projectId}/status",
"properties": {
"errorCode": "DI-ADAPTER-STA-0001"
}