Retrieves execution logs for a specified mainframe pipeline within a project.
HTML
GET https://hostname/v1/integration/mainframe/monitoring/projects/{projectId}/pipelines/{pipelineId}/logsSupports pagination, filtering, and optional daemon log inclusion for comprehensive pipeline monitoring.
Process Overview
- Fetch pipeline deployment engine logs.
- Optionally fetch daemon (sqdaemon) logs if requested.
- Support text and regex-based search filtering.
- Return paginated log data based on specified page size and page numbers.
Key Features
- Comprehensive log retrieval with pagination support.
- Text and regex search filtering capabilities.
- Configurable page size in kilobytes.
Required Permissions
replication-pipeline::view
Request
Path parameters
| Key | Required | Type | Description |
|---|---|---|---|
| projectId | Yes | string |
Unique identifier of the project containing the pipeline |
| pipelineId | Yes | string |
Unique identifier of the pipeline for which logs are being retrieved |
Query parameters
| Key | Required | Type | Description |
|---|---|---|---|
| pageSizeInKB | No | integer | Page size in kilobytes for log retrieval. Controls the amount of log data returned per page. |
| includeDaemon | No | boolean | Include daemon (sqdaemon) logs in the response. If false, only pipeline-specific logs are returned. |
| daemonLogPage | No | integer | Page number for daemon logs (applicable only if includeDaemon is true). |
| pipelineLogPage | No | integer | Page number for pipeline logs. |
| searchText | No | string | Text to search within the logs. If provided, only matching log lines are returned. |
| isRegexSearch | No | boolean | Whether the searchText string should be treated as a regular expression. If false, performs plain text search. |
Response
Response body properties
| Property | Required | Type | Description |
|---|---|---|---|
| pipelineLogs | No | ||
| daemonLogs | No |
Response examples
Example status code responses for this method are shown here.
"pipelineLogs": {
"logs": "[INFO] Pipeline deployment initiated...",
"logs": "[INFO] Processing data...",
"pageNumber": "1",
"totalPages": "5"
}
"daemonLogs": {
"logs": "[DEBUG] Daemon processing data...",
"logs": "[DEBUG] Synchronizing...",
"pageNumber": "1",
"totalPages": "3"
}"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}/pipelines/{pipelineId}/logs",
"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}/pipelines/{pipelineId}/logs",
"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}/pipelines/{pipelineId}/logs",
"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}/pipelines/{pipelineId}/logs",
"properties": {
"errorCode": "DI-ADAPTER-DFL-0007"
}"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}/pipelines/{pipelineId}/logs",
"properties": {
"errorCode": "DI-ADAPTER-MFD-0015"
}