Getting A List Of Audit Trails | Taurus Developer Hub

Basic Description

This endpoint is used to get a list of Audit Trails in Taurus-PROTECT.

This endpoint would accept a GET request with no required parameters. By default, the request will return all audit trails. However, it also provides the flexibility to filter audit trails based on various parameters such as date, entity, and more. Furthermore, the resulting list can also be sorted according to specific criteria.

Prerequisites

Required Roles

Certain API endpoints require that the user has a specific role in order to access them. Roles are used to restrict access to certain functionality within the system and ensure that only authorized users are able to perform specific actions.

Here is the list of required Roles for this particular endpoint:

AuditViewer
TPUser

To find out more about roles, please refer to the following page in the Taurus User Guides.

Required Input Parameters

There are no Required Input Parameters for this endpoint.

Preconditions

It is important to note that Audit Trails are only available on Taurus-PROTECT 3.14 and later versions.

Call Example

You can find a basic example in cURL below.

Please note that you will need to update the BASEURL and the APITOKEN for the command to function.

cURL

export BASEURL=https://taurus-protect-instance.com
export APIToken=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6MSwiZXh0ZXJuYWxVc2VySUQiOiJ0ZWFtMUV4dGVybmFsVXNlcklEIiwidGVuYW50SUQiOjEsImNhcGl0YWxUZW5hbnRJRCI6MSwiZmlyc3RuYW1lIjoiSm9obiIsImxhc3RuYW1lIjoiRG9lIiwicm9sZXMiOlsidHB1c2VyIl0sImVtYWlsIjoidGVhbTFAYmFuay5jb20iLCJ1c2VybmFtZSI6InRlYW0xIiwiand0X3JlbmV3YWJsZV9hbW91bnQiOjAsImlzX3RvdHBfZW5hYmxlZCI6ZmFsc2UsImF1dGhfc3RhdHVzIjoiU1VDQ0VTUyIsImxhc3RfbG9naW4iOiIyMDIzLTAxLTAxVDAwOjAwOjAwLjE0OTc0NDIzMloiLCJsb2dnZWRfaW5fd2l0aF9zc28iOmZhbHNlLCJrZXkiOiIiLCJleHAiOjE2ODEyMTkyNzYsImlhdCI6MTY4MTIxNzQ3Nn0.K_85arIrigpkN1yHttCydpeT6oVg2c6PyQnuji907Og
curl --location "$BASEURL/api/rest/v1/audit_trails" \
--header 'Content-Type: application/json' \
--header 'Accept: application/json' \
--header "Authorization: Bearer $APIToken"

This piece of code submits a GET request to https://your-protect-instance.example.com/api/rest/v1/audit_trails with no parameters.

Call Result

A successful response for the GET call to get the list of all audit trails in Taurus-PROTECT might look like this:

In this example, Taurus-PROTECT responds with a JSON object containing a list of all the audit trails in Taurus-PROTECT.

Requirements for Future Use

For this endpoint, the storing requirements vary according to the use case.

You can find the Swagger-generated page for this endpoint in the following link.