Skip to main content
GET
Export the deployment's audit events
The reference panel describes the current v3 operation. The notes below describe its v2 compatibility API. Follow the v3 request schema for current calls: v3 can move identifiers from the body or query into the URL. Keep the v2 method, path, and payload together when using the compatibility API.

v2 compatibility notes

Returns one page of the deployment’s audit events in the window, newest first. Filter by category to export one category. See Compliance for who can export and how paging works.

Example

Authorizations

Authorization
string
header
required

An External App: the JWT it obtains from POST /oauth/token with OAuth2 client_credentials. Pass as Authorization: Bearer <jwt>. An app's static companion key also authenticates as the app, but is deprecated and is not protected by Idempotency-Key.

Query Parameters

startTime
integer
required

Window start, epoch milliseconds.

endTime
integer
required

Window end, epoch milliseconds; at most 90 days after startTime.

limit
integer
default:100

Records per page, 1 to 1,000. A value above 1,000 is 400 too_big; a value below 1 reads 1.

Required range: 1 <= x <= 1000
cursor
string

The previous page's cursor, unchanged. It is opaque.

category
string

Only audit events of this category.

Response

One page of audit events

data
object
required

One page of the deployment's audit events, newest first. Each record is the stored row as written (an open object with a stable id), including principal and person-resource events: the exports are for a deployment-root auditor. Follow cursor until it is null.

meta
object
required