Audit Logs

Load your account’s audit logs for monitoring activities on Talend Cloud applications, ensuring data security and managing regulatory compliance risks.
Contact
TPSVC Team
License
Apache License Version 2.0

Endpoints

Global security

These security schemes apply to the entire API

Security scheme

This scheme can be referenced across the API

Public
Bearer authentication
NameDescription
FormatBearer <TOKEN>
Headers
NameDescriptionTypeAttributes and examples
Authorizationstring Required

Return audit logs for current account with the latest date on top

GET /security/audit/logs
Return audit logs about the events triggered within the hot period defined by your license. With the latest timestamp on top, the results are paginated with the page number and page size parameters. The pagination information is part of the response header. The status codes explained on this page are the codes used by the Audit log API. If you need information about the HTTP status codes that appear in the body of your audit logs, see https://en.wikipedia.org/wiki/List_of_HTTP_status_codes

Request

Query parameters
NameDescriptionTypeAttributes and examples
fromDateLower bound of the date window (ISO 8601 datetime format). Specifying this parameter will return audit logs from this date to toDate parameter if present or to current date otherwise. fromDate parameter must be before current date. If format is not as expected, if fromDate is after current date or if fromDate is after toDate, status 400 BAD REQUEST is returned. If fromDate is before current date minus hot period duration, current date minus hot period duration is used instead. If fromDate is not specified and fromId is specified, fromId is used to define the oldest log to return. Otherwise, current date minus hot period duration is used.datetime Optional
Example
2020-03-02T06:22:57.447Z
fromIdLower bound of the log window (UUID). Specifying this parameter will return audit logs from a specific id to toDate if present, or current date otherwise. If the id doesn’t exist, an empty array is returned. If format is not as expected, status 400 BAD REQUEST is returned. If fromDate and fromId are both specified with valid values, fromId is ignored and fromDate is used to define the oldest log to return.string Optional
Example
110e8400-e29b-11d4-a716-446655440000
pagePage number starting from 1.string Optional
Default1
Example
1
sizeNumber of logs returned per page. The maximum value is 1000.string Optional
Default100
Example
100
toDateUpper bound of the date window (ISO 8601 datetime format). Specifying this parameter will return audit logs from fromDate if present, or from fromId if present, or from current date minus period hot duration otherwise, to toDate. If format is not as expected or if toDate is before fromDate, status 400 BAD REQUEST si returned. If toDate if after current date, current date is used instead.datetime Optional
Example
2020-03-02T06:22:57.447Z
Headers
NameDescriptionTypeAttributes and examples
AuthorizationBearer {your personal access token}string Required
Pattern[Bb]earer .+

Response

200Status 200
Logs have been retrieved for the current account
Headers
NameDescriptionTypeAttributes and examples
page-firstWhether the current page is the first page: “true” if it is and “false” if it is not.boolean Optional
Example
true
page-numberCurrent page numberinteger Optional
FormatINT32
Example
1
total-elementsTotal number of audit logs retrievable using the APIinteger Optional
FormatINT32
Example
100
total-pagesNumber of pagesinteger Optional
FormatINT32
Example
2
page-lastWhether the current page is the last page: “true” if it is and “false” if it is not.boolean Optional
Example
false
page-total-elementsNumber of audit logs in the current pageinteger Optional
FormatINT32
Example
10
Body
*/*
details
NameDescriptionTypeAttributes and examples
array of AuditLog
Datatype details
TypeDescriptionAttributes and examples
array
AuditLog
400Status 400
Wrong parameter format
401Status 401
Not authenticated
403Status 403
User has insufficient permission (Security Administrator role is required) or support level is too low (Platinum or Mission Critical are required)
404Status 404
Not Found
429Status 429
Too many requests within a certain timeframe
500Status 500
Internal server error

AuditLog

Object
NameDescriptionTypeAttributes and examples
timestampDatetime when the log has been registered (Iso 8601 datetime)datetime Optional
Example
2020-01-13T10:25:40.447Z
logIdUnique log id (UUID)string Optional
Example
110e8400-e29b-11d4-a716-446655440000
requestIdUnique request id (UUID)string Optional
Example
508c5f4c-d885-4e0b-9052-b3f5b8e27472
applicationIdApplication idstring Optional
Example
TMC
eventCategoryEvent categorystring Optional
Example
user account
eventTypeEvent typestring Optional
Example
access management
eventOperationEvent operationstring Optional
Example
create
clientIpIp address of the client. The field can contain multiple IPs in case of forgery attempt or multiple public proxiesstring Optional
Example
84.14.92.154, 62.23.50.122
userIdTechnical user idstring Optional
Example
25190235-7914-4410-8c1d-c1011f57edfd
usernameUsernamestring Optional
Example
admin@test.talend.com
emailUser emailstring Optional
Example
admin@customer.com
requestAuditLogRequest Optional
responseAuditLogResponse Optional

AuditLogRequest

Object
NameDescriptionTypeAttributes and examples
urlRequest URLstring Optional
Example
http://service.url/service
methodRequest methodstring Optional
Example
POST
userAgentRequest user agentstring Optional
Example
PostmanRuntime/7.24.0
bodyRequest bodystring Optional

AuditLogResponse

Object
NameDescriptionTypeAttributes and examples
codeResponse HTTP status code. For more information, see https://en.wikipedia.org/wiki/List_of_HTTP_status_codesstring Optional
Example
200
bodyResponse bodystring Optional
back to top↑