Execution Logs

Retrieve logs about task runs.

Endpoints

Global security

These security schemes apply to the entire API

Security scheme

This scheme can be referenced across the API

Public
This Bearer authentication can be set in the Authorization header of your requests. Authentication tokens and Personal Access Tokens are supported. Personal Access Tokens can be generated in the Profile Preferences page of the Talend Cloud Portal.
Bearer authentication
NameDescription
FormatBearer <token>

Logs

Delete logs of a specified execution

DELETE /monitoring/executions/{id}/logs
This endpoint allows users with the Execution Logs - Delete permission (ID: EXECUTION_LOGS_DELETE) to delete logs for a given execution identified by its ID.

Request

Path variables
NameDescriptionTypeAttributes and examples
idstring Required

Response

200Status 200
The logs have been deleted successfully or there are no logs to be deleted.
Body
Object
400Status 400
execution ID is not a UUID
Body
ErrorResponse
401Status 401
Not authorized to access resources
Body
ErrorResponse
403Status 403
No permissions to access resources
Body
ErrorResponse
404Status 404
Execution with provided ID, has not been found
Body
ErrorResponse
500Status 500
Something went wrong and some or none of the execution logs have been deleted
Body
ErrorResponse

Generate logs for a completed or ongoing execution

POST /monitoring/executions/{id}/logs

This endpoint generates the log of a given task run and returns a download token for this log (maximum log size: 100,000). Logs earlier than 30 days are deleted This token is valid for one hour.

If the desired log size exceeds the 100,000-entry limit, use the time range parameters (startTime or endTime or both) to split the requests. Adjust the time range for each request to retrieve all log entries by making multiple calls.
For example, use endTime in each request to retrieve up to 100,000 log entries before that time. Repeat with earlier endTime values until you have retrieved the desired log history.

Request

Path variables
NameDescriptionTypeAttributes and examples
idstring Required
Query parameters
NameDescriptionTypeAttributes and examples
fileFormatFormat of the log file to be generated. The available formats are json and text.string Optional
JSON
endTimeLatest date and time of the logs to be put in the generated log. By default, current time is usedstring Optional
newFileName

This parameter indicates whether you need to include task IDs and execution IDs in the filename of the log to be generated. It generates a distinctive file name reading like: taskID_executionID.log

It is recommended to set this value to be true as the old filename format is going to be deprecated.

boolean Optional
startTimeThe earliest log entries by date and time to include in the generated log.
Log entries older than 30 days are automatically deleted. If you omit this parameter, the generated log includes available entries from the start of the run.
If the run started more than 30 days before the request, only entries from the 30 days before the request are available.
string Optional

Response

200Status 200
Successful response
Body
Object
NameDescriptionTypeAttributes and examples
sizeNumber of lines in logsinteger Required
tokenToken used to check the status of the log file generationstring Required
206Status 206
The downloaded logs contain only partial content due to the maximum log size limit of 100,000 entries.
Body
Object
NameDescriptionTypeAttributes and examples
sizeNumber of lines in logsinteger Required
tokenToken used to check the status of the log file generationstring Required
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
ErrorResponse
404Status 404
Not found - resource not found
Body
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
ErrorResponse

Get task execution logs

GET /monitoring/executions/{id}/logs
Get run logs of a given task by its execution ID (also referred to as run ID).
Logs earlier than 30 days are automatically cleared.

Request

Path variables
NameDescriptionTypeAttributes and examples
idstring Required
Query parameters
NameDescriptionTypeAttributes and examples
countNumber of log entries to return. The default value is 50 and the maximum value is 200number Optional
50
endTimelatest date and time of the logs to be retrieved. By default, current time is useddatetime Optional
orderThe way in which the returned logs are sorted by their timestamps. The default value is DESC, meaning the latest logs are put firststring Optional
DESC
startIndexStart position of the pagination of the logs, greater or equal to 0number Optional
startTimeThe earliest log entries by date and time to include in the generated log.
Log entries older than 30 days are automatically deleted. If you omit this parameter, the generated log includes available entries from the start of the run.
If the run started more than 30 days before the request, only entries from the 30 days before the request are available.
datetime Optional

Response

200Status 200
Successful response
Body
Object
NameDescriptionTypeAttributes and examples
sizeNumber of log entries in the current pagenumber Required
totalSizeTotal number of log entries for the give execution IDnumber Required
totalSizeFilteredTotal number of log entries for the given execution ID, for the specific time range defned in the requestnumber Optional
dataarray of Object Optional
Datatype details
TypeDescriptionAttributes and examples
arrayList of execution logs. Log messages are in raw format, including information about severity, message, timestamps and so on.
Object
NameDescriptionTypeAttributes and examples
severitystring Optional
logTypestring Optional
logTimestampinteger Optional
logMessagestring Optional
bundleNamestring Optional
bundleVersionstring Optional
podNamestring Optional
nextIndexNext index for pagination if it existsnumber Optional
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
ErrorResponse
404Status 404
Not found - resource not found
Body
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
ErrorResponse

Check log generation status and return download URL

POST /monitoring/executions/{id}/logs/status

Check the status of the generated log and return a download URL.

You need to put the download token in the body.

Request

Path variables
NameDescriptionTypeAttributes and examples
idstring Required
Body
Token returned to the request at the POST /monitoring/executions/{id}/logs endpoint.
string
application/json
aec20220-f745-4da6-a5e0-b6dfe083eee5

Response

200Status 200
Successful response
Body
Object
NameDescriptionTypeAttributes and examples
presignedURLURL to download full logs, valid for 60 minutesstring Optional
statusStatus of full log file generationstring Required
400Status 400
Bad Request
Body
ErrorResponse
401Status 401
Unauthorized
Body
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
ErrorResponse
404Status 404
Not found - resource not found
Body
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
ErrorResponse

ErrorResponse

Object
NameDescriptionTypeAttributes and examples
statusnumber Required
messagestring Optional
requestIdstring Optional
detaildetail message for 401 - unauthorized errorstring Optional
back to top↑