--- title: Get a list of Audit Logs events description: List endpoint returns events that match a Audit Logs search query. [Results are paginated][1]. breadcrumbs: Docs > API > Get a list of Audit Logs events --- > For the complete documentation index, see [llms.txt](https://dnd37xeb23o8n.cloudfront.net/stefon.simmons/docs-astro-web-10435/llms.txt). # Get a list of Audit Logs events ## v2 (latest) | Datadog site | API endpoint | | ----------------- | ----------------------------------------------------- | | app.datadoghq.com | GET https://api.datadoghq.com/api/v2/audit/events | | us3.datadoghq.com | GET https://api.us3.datadoghq.com/api/v2/audit/events | | us5.datadoghq.com | GET https://api.us5.datadoghq.com/api/v2/audit/events | | app.datadoghq.eu | GET https://api.datadoghq.eu/api/v2/audit/events | | ap1.datadoghq.com | GET https://api.ap1.datadoghq.com/api/v2/audit/events | | ap2.datadoghq.com | GET https://api.ap2.datadoghq.com/api/v2/audit/events | | uk1.datadoghq.com | GET https://api.uk1.datadoghq.com/api/v2/audit/events | | app.ddog-gov.com | GET https://api.ddog-gov.com/api/v2/audit/events | | us2.ddog-gov.com | GET https://api.us2.ddog-gov.com/api/v2/audit/events | ### Overview List endpoint returns events that match a Audit Logs search query. [Results are paginated](https://docs.datadoghq.com/logs/guide/collect-multiple-logs-with-pagination.md). Use this endpoint to see your latest Audit Logs events. This endpoint requires the `audit_logs_read` permission. ### Arguments #### Query Strings | Field | Type | Description | | ------------- | ------- | --------------------------------------------------------------------------- | | filter[query] | string | Search query following Audit Logs syntax. | | filter[from] | string | Minimum timestamp for requested events. | | filter[to] | string | Maximum timestamp for requested events. | | sort | enum | Order of events in results. Allowed enum values: `timestamp`, `-timestamp`. | | page[cursor] | string | List following results with a cursor provided in the previous query. | | page[limit] | integer | Maximum number of events in the response. Default: `10`. | ### Response {% tabs %} {% tab label="200" %} OK {% tabs %} {% tab label="Model" %} Response object with all events matching the request and pagination information. | Parent field | Field | Type | Description | | ------------ | ---------- | --------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | | data | [object] | Array of events matching the request. | | data | attributes | object | JSON object containing all event attributes and their associated values. | | attributes | attributes | object | JSON object of attributes from Audit Logs events. | | attributes | message | string | Message of the event. | | attributes | service | string | Name of the application or service generating Audit Logs events. This name is used to correlate Audit Logs to APM, so make sure you specify the same value when you use both products. | | attributes | tags | [string] | Array of tags associated with your event. | | attributes | timestamp | date-time | Timestamp of your event. | | data | id | string | Unique ID of the event. | | data | type | enum | Type of the event. Allowed enum values: `audit`. Default: `audit`. | | | links | object | Links attributes. | | links | next | string | Link for the next set of results. Note that the request can also be made using the POST endpoint. | | | meta | object | The metadata associated with a request. | | meta | elapsed | int64 | Time elapsed in milliseconds. | | meta | page | object | Paging attributes. | | page | after | string | The cursor to use to get the next results, if any. To make the next request, use the same parameters with the addition of `page[cursor]`. | | meta | request_id | string | The identifier of the request. | | meta | status | enum | The status of the response. Allowed enum values: `done`, `timeout`. | | meta | warnings | [object] | A list of warnings (non-fatal errors) encountered. Partial results may return if warnings are present in the response. | | warnings | code | string | Unique code for this type of warning. | | warnings | detail | string | Detailed explanation of this specific warning. | | warnings | title | string | Short human-readable summary of the warning. | {% /tab %} {% tab label="Example" %} ```json { "data": [ { "attributes": { "attributes": { "customAttribute": 123, "duration": 2345 }, "message": "string", "service": "web-app", "tags": [ "team:A" ], "timestamp": "2019-01-02T09:42:36.320Z" }, "id": "AAAAAWgN8Xwgr1vKDQAAAABBV2dOOFh3ZzZobm1mWXJFYTR0OA", "type": "audit" } ], "links": { "next": "https://app.datadoghq.com/api/v2/audit/event?filter[query]=foo&page[cursor]=eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "meta": { "elapsed": 132, "page": { "after": "eyJzdGFydEF0IjoiQVFBQUFYS2tMS3pPbm40NGV3QUFBQUJCV0V0clRFdDZVbG8zY3pCRmNsbHJiVmxDWlEifQ==" }, "request_id": "MWlFUjVaWGZTTTZPYzM0VXp1OXU2d3xLSVpEMjZKQ0VKUTI0dEYtM3RSOFVR", "status": "done", "warnings": [ { "code": "unknown_index", "detail": "indexes: foo, bar", "title": "One or several indexes are missing or invalid, results hold data from the other indexes" } ] } } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="400" %} Bad Request {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="403" %} Not Authorized {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% tab label="429" %} Too many requests {% tabs %} {% tab label="Model" %} API error response. | Field | Type | Description | | ------------------- | -------- | ----------------- | | errors [*required*] | [string] | A list of errors. | {% /tab %} {% tab label="Example" %} ```json { "errors": [ "Bad Request" ] } ``` {% /tab %} {% /tabs %} {% /tab %} {% /tabs %} ### Code Example {% tabs %} {% tab label="Curl" %} ```bash # Set your Datadog site and credentials export DD_SITE="datadoghq.com" # Or us3.datadoghq.com, us5.datadoghq.com, datadoghq.eu, ap1.datadoghq.com, ap2.datadoghq.com, uk1.datadoghq.com, ddog-gov.com, us2.ddog-gov.com # Use a Personal Access Token or Service Access Token export DD_BEARER_TOKEN="" curl -X GET "https://api.${DD_SITE}/api/v2/audit/events" \ -H "Accept: application/json" \ -H "Authorization: Bearer ${DD_BEARER_TOKEN}" ``` {% /tab %} {% tab label="Go" %} ```go // Get a list of Audit Logs events returns "OK" response package main import ( "context" "encoding/json" "fmt" "os" "github.com/DataDog/datadog-api-client-go/v2/api/datadog" "github.com/DataDog/datadog-api-client-go/v2/api/datadogV2" ) func main() { ctx := datadog.NewDefaultContext(context.Background()) ctx = context.WithValue(ctx, datadog.ContextAccessToken, os.Getenv("DD_BEARER_TOKEN")) configuration := datadog.NewConfiguration() apiClient := datadog.NewAPIClient(configuration) api := datadogV2.NewAuditApi(apiClient) resp, r, err := api.ListAuditLogs(ctx, *datadogV2.NewListAuditLogsOptionalParameters()) if err != nil { fmt.Fprintf(os.Stderr, "Error when calling `AuditApi.ListAuditLogs`: %v\n", err) fmt.Fprintf(os.Stderr, "Full HTTP response: %v\n", r) } responseContent, _ := json.MarshalIndent(resp, "", " ") fmt.Fprintf(os.Stdout, "Response from `AuditApi.ListAuditLogs`:\n%s\n", responseContent) } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=go) and then save the example to `main.go` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" go run "main.go" ``` {% /tab %} {% tab label="Java" %} ```java // Get a list of Audit Logs events returns "OK" response import com.datadog.api.client.ApiClient; import com.datadog.api.client.ApiException; import com.datadog.api.client.v2.api.AuditApi; import com.datadog.api.client.v2.model.AuditLogsEventsResponse; public class Example { public static void main(String[] args) { ApiClient defaultClient = ApiClient.getDefaultApiClient(); defaultClient.setAccessToken(System.getenv("DD_BEARER_TOKEN")); AuditApi apiInstance = new AuditApi(defaultClient); try { AuditLogsEventsResponse result = apiInstance.listAuditLogs(); System.out.println(result); } catch (ApiException e) { System.err.println("Exception when calling AuditApi#listAuditLogs"); System.err.println("Status code: " + e.getCode()); System.err.println("Reason: " + e.getResponseBody()); System.err.println("Response headers: " + e.getResponseHeaders()); e.printStackTrace(); } } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=java) and then save the example to `Example.java` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" java "Example.java" ``` {% /tab %} {% tab label="Python" %} ```python """ Get a list of Audit Logs events returns "OK" response """ from os import environ from datadog_api_client import ApiClient, Configuration from datadog_api_client.v2.api.audit_api import AuditApi configuration = Configuration() configuration.access_token = environ["DD_BEARER_TOKEN"] with ApiClient(configuration) as api_client: api_instance = AuditApi(api_client) response = api_instance.list_audit_logs() print(response) ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=python) and then save the example to `example.py` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" python3 "example.py" ``` {% /tab %} {% tab label="Ruby" %} ```ruby # Get a list of Audit Logs events returns "OK" response require "datadog_api_client" DatadogAPIClient.configure do |config| config.access_token = ENV["DD_BEARER_TOKEN"] end api_instance = DatadogAPIClient::V2::AuditAPI.new p api_instance.list_audit_logs() ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=ruby) and then save the example to `example.rb` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" rb "example.rb" ``` {% /tab %} {% tab label="Rust" %} ```rust // Get a list of Audit Logs events returns "OK" response use datadog_api_client::datadog; use datadog_api_client::datadogV2::api_audit::AuditAPI; use datadog_api_client::datadogV2::api_audit::ListAuditLogsOptionalParams; #[tokio::main] async fn main() { let configuration = datadog::Configuration::new(); let api = AuditAPI::with_config(configuration); let resp = api .list_audit_logs(ListAuditLogsOptionalParams::default()) .await; if let Ok(value) = resp { println!("{:#?}", value); } else { println!("{:#?}", resp.unwrap_err()); } } ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=rust) and then save the example to `src/main.rs` and run following commands: ```bash DD_SITE="datadoghq.com" DD_API_KEY="" DD_APP_KEY="" cargo run ``` {% /tab %} {% tab label="TypeScript" %} ```typescript /** * Get a list of Audit Logs events returns "OK" response */ import { client, v2 } from "@datadog/datadog-api-client"; const configuration = client.createConfiguration({ authMethods: { AuthZ: { accessToken: process.env.DD_BEARER_TOKEN as string, }, }, }); const apiInstance = new v2.AuditApi(configuration); apiInstance .listAuditLogs() .then((data: v2.AuditLogsEventsResponse) => { console.log( "API called successfully. Returned data: " + JSON.stringify(data) ); }) .catch((error: any) => console.error(error)); ``` #### Instructions First [install the library and its dependencies](https://dnd37xeb23o8n.cloudfront.net/api/latest.md?code-lang=typescript) and then save the example to `example.ts` and run following commands: ```bash DD_SITE="datadoghq.com" DD_BEARER_TOKEN="" tsc "example.ts" ``` {% /tab %} {% /tabs %}