GET
/
api
/
audit-logs
List audit logs
curl --request GET \
  --url https://{tenant}/api/audit-logs \
  --header 'Authorization: Bearer <token>'
This response does not have an example.

Authorizations

​
Authorization
string
header
required

The Tyk Dashboard API Access Credentials

Query Parameters

​
p
integer

Use p query parameter to say which page you want returned. The size of the page is determined by the configuration option page_size of dashboard.

​
user
string

Filters audit logs to show only actions performed by the specified user. This parameter allows you to focus on the activity of a particular user across the system.

​
action
string

Filters audit logs based on the specific action performed by users. This parameter allows you to focus on particular types of activities within the system.

​
ip
string

Filters audit logs based on the IP address from which the action originated. This parameter allows you to focus on activities from specific network locations or to investigate actions from particular IP addresses.

​
method
string

Filters audit logs based on the HTTP method used in the API request. This parameter allows you to focus on specific types of operations performed on the API.

​
status
integer

Filters audit logs based on the HTTP status code returned by the API in response to the request. This parameter allows you to focus on specific outcomes of API interactions.

​
url
string

This parameter filters audit logs based on partially matching the accessed API endpoint's URL path. It allows searching for actions performed on related resources or sections of the API by matching any portion of the URL. The match is case-sensitive and ignores additional path segments or query parameters beyond the matched portion. For example, if the database contains URLs like /tib/create, /tib/get/1?schema=json, /api/schema, and /schema1 searching with url=schema would return /api/schema and /schema1.

​
from_date
string

Specifies the start date for the audit log search. If not provided, the search will include records from the earliest available date. Format DD-MM-YYY.

​
to_date
string

Specifies the end date for the audit log search. If not provided, the search will include records up to the current date and time. Format DD-MM-YYY.

​
download
boolean

Determines whether the response should be a downloadable file containing the records. If set to true, the API returns a file instead of a JSON list of records. When enabled, pagination is not applied, and the file will include all records that match the search criteria.

​
type
enum<string>

Specifies the format of the downloadable file. This parameter is only applied when download is set to true. If set to csv, the file content will be in CSV format; otherwise, JSON format will be used.

Available options:
csv,
json

Response

Audit Logs retrieved successfully

A file containing the audit logs in either JSON or CSV format, depending on the type query parameter.