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

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
Name Description Type Attributes and examples
id string Required

Response

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

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.

Use cases

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
DefaultJSON
Enum
  • JSON
  • TEXT
Example
fileFormat=TEXT
endTime Latest date and time of the logs to be put in the generated log. By default, current time is used string Optional
Example
2021-06-14T15:04:45Z
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 string Optional
Example
2021-06-14T07:01:45Z

Response

200Status 200
Successful response
Body
application/json
Object
Name Description Type Attributes and examples
size Number of lines in logs integer Required
token Token used to check the status of the log file generation string Required
206Status 206
The downloaded logs contain only partial content due to the maximum log size limit of 100,000 entries.
Body
application/json
Object
Name Description Type Attributes and examples
size Number of lines in logs integer Required
token Token used to check the status of the log file generation string Required
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
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)

Use cases

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
Default50
endTime latest date and time of the logs to be retrieved. By default, current time is used datetime Optional
Example
2021-06-14T15:04:45Z
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
DefaultDESC
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 datetime Optional
Example
2021-06-14T07:01:45Z

Response

200Status 200
Successful response
Body
application/json
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
Example
[
   {
      "logTimestamp":1614696623123,
      "severity":"INFO",
      "logType":"type",
      "logMessage":"message",
      "bundleName":"bundleName",
      "bundleVersion":"bundleId",
      "podName": "podName"
   }
]
Name Description Type Attributes and examples
severity string Optional
logType string Optional
logTimestamp integer Optional
logMessage string Optional
bundleName string Optional
bundleVersion string Optional
podName string Optional
nextIndex Next index for pagination if it exists number Optional
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
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.

Use cases

Request

Path variables
Name Description Type Attributes and examples
id string Required
Body
application/json
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
application/json
Object
Name Description Type Attributes and examples
presignedURL URL to download full logs, valid for 60 minutes string Optional
status Status of full log file generation string Required
Enum
  • READY
  • IN_PROGRESS
400Status 400
Bad Request
Body
application/json
ErrorResponse
401Status 401
Unauthorized
Body
application/json
ErrorResponse
403Status 403
Forbidden - no permissions to access resource
Body
application/json
ErrorResponse
404Status 404
Not found - resource not found
Body
application/json
ErrorResponse
500Status 500
Server error - something went wrong on server side
Body
application/json
ErrorResponse

ErrorResponse

Object
Name Description Type Attributes and examples
status number Required
message string Optional
requestId string Optional
detail detail message for 401 - unauthorized error string Optional
back to top↑