Applies to ReadyAPI 3.5, last modified on November 26, 2020

The Audit Log contains information about the events that occurred in TestEngine, for example, server starting, creation of users, deletion of jobs and so on. For such actions, TestEngine records a timestamp, the name of the user who initiated the action, and the event data.

To view the Audit Log, you can either use the web interface of TestEngine or send a request to the TestEngine API using curl, ReadyAPI or any other similar tool.

Note: Only administrators can view the Audit Log.

Using API

Use the following operation:

GET  http://<testengine-host>:8080/api/v1/auditlog[?userName=name[&from=date][&to=date][&sortOrder=string]

userName

This parameter is optional. If it is specified, the Audit Log will include only the events initiated by this user.

from

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the log entries created after this date and time will be retrieved.

Tip: Z in the notation indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

to

A date and time in the YYYY-MM-DDThh:mm:ssZ format. If it is specified, only the log entries created before this date and time will be retrieved.

Tip: Z in the notation indicates the UTC time. If you need to indicate a different time zone, replace it with +hh:mm or -hh:mm.

sortOrder

The sorting order of log entries. Possible values: ASC (for the ascending chronological order), DESC (for the descending chronological order).

This parameter is optional. If it is not specified, the results will be presented in the descending chronological order.

Authentication

The request must be authenticated by a TestEngine user.

See details on SwaggerHub.

Example

Using Web UI

  1. Go to the home page of TestEngine:

    http://<testengine-host>:<port>/

    For example, if TestEngine is installed on your local machine and you run it on the default port, use the following link:

  2. Go to Admin > Audit Log:

    Audit Log

    Click the image to enlarge it.

To filter log entries, click Filter and enter filter queries in the User or Action column:

Audit Log: Filter events

Click the image to enlarge it.

To sort log entries, click on the header of any column.

See Also

Get Results
Get Status

Highlight search results