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
Name Description
Format Bearer <token>

Logs

Generate full logs for a completed or ongoing execution

POST /monitoring/executions/{id}/logs
This endpoint generates the full log of a given task run and returns a download token to this log.
This token is valid for one hour.

Request

Path variables
Name Description Type Attributes and examples
id string Required
Query parameters
Name Description Type Attributes and examples
fileFormat Format of the log file to be generated. The available formats are json and text. string Optional
json
endTime Latest date and time of the logs to be put in the generated log. By default, current time is used date 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
startTime Earliest date and time of the logs to be put in the generated log. By default, logs are retrieved from the start time of the run date Optional

Response

200Status 200
Successful response
Body
Object
Name Description Type Attributes and examples
size Number of lines in logs number Required
token Token used to check the status of the log file generation string Required
400Status 400
Bad Request
401Status 401
Unauthorized
403Status 403
Forbidden - no permissions to access resource
404Status 404
Not found - resource not found
500Status 500
Server error - something went wrong on server side

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)

Request

Path variables
Name Description Type Attributes and examples
id string Required
Query parameters
Name Description Type Attributes and examples
count Number of log entries to return. The default value is 50 and the maximum value is 200 number Optional
50
endTime latest date and time of the logs to be retrieved. By default, current time is used date Optional
order The way in which the returned logs are sorted by their timestamps. The default value is DESC, meaning the latest logs are put first string Optional
DESC
startIndex Start position of the pagination of the logs, greater or equal to 0 number Optional
startTime Earliest date and time of the logs to be put in the generated log. By default, logs are retrieved from the start time of the run date Optional

Response

200Status 200
Successful response
Body
Object
Name Description Type Attributes and examples
size Number of log entries in the current page number Required
totalSize Total number of log entries for the give execution ID number Required
totalSizeFiltered Total number of log entries for the given execution ID, for the specific time range defned in the request number Optional
data array of Object Optional
Datatype details
Type Description Attributes and examples
array List of execution logs. Log messages are in raw format, including information about severity, message, timestamps and so on.
Object
nextIndex Next index for pagination if it exists number Optional
400Status 400
Bad Request
401Status 401
Unauthorized
403Status 403
Forbidden - no permissions to access resource
404Status 404
Not found - resource not found
500Status 500
Server error - something went wrong on server side

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
Name Description Type Attributes and examples
id string Required
Query parameters
Name Description Type Attributes and examples
token Token returned to the request at the POST /monitoring/executions/{id}/logs endpoint. string Required

Response

200Status 200
Successful response
Body
Object
Name Description Type Attributes and examples
presignedURL URL to download full logs, valid for 60 minutes number Optional
status Status of full log file generation string Required
400Status 400
Bad Request
401Status 401
Unauthorized
403Status 403
Forbidden - no permissions to access resource
404Status 404
Not found - resource not found
500Status 500
Server error - something went wrong on server side
back to top