Developers
Audit entries2

List audit entries

GET/audit-entries

Lists the audit entries of the current account: write operations, denied or rejected requests, background effects, and management actions. Successful read requests are not included; they are available through the Requests endpoints.

Results are paginated by cursor and sorted by occurred_at, newest first by default. The collection can be filtered by kind, outcome, action code, resource, request ID, and occurrence time range.

Requires the audit.read permission for the account.

Authorization

AuthorizationBearer <token>

Autonomous mode: the API credential secret, sent as a bearer token. Credential secrets are identified by a fixed prefix.

In: header

Query Parameters

limit?integer

Maximum number of items to return, from 1 to 200.

Range1 <= value <= 200
cursor?string

Cursor for the next page, taken from page.next_cursor of the previous response.

sort?string

Sort order. A leading - sorts in descending order.

Value in

  • "occurred_at"
  • "-occurred_at"
kind[]?array<string>

Only entries of these kinds. Repeat the parameter to match any of several kinds.

outcome[]?array<string>

Only entries with these outcomes. Repeat the parameter to match any of several outcomes.

action_code?string

Only entries with this action code.

resource_type?string

Only entries about resources of this type.

resource_id?string

Only entries about the resource with this public ID.

request_id?string

Only entries recorded by the request with this ID, as returned in X-Request-Id.

occurred_after?string

Only items that occurred after this date and time (ISO 8601).

Formatdate-time
occurred_before?string

Only items that occurred before this date and time (ISO 8601).

Formatdate-time

Header Parameters

X-Client-Request-Id?string

Optional client-generated identifier of the request, up to 64 characters from [A-Za-z0-9._-]. Echoed back in the response and recorded in the request log; it never replaces the server-generated X-Request-Id.

Lengthlength <= 64

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/audit-entries"
{  "data": [    {      "action": "string",      "actor": {        "admin_id": "string"      },      "client_request_id": "string",      "credential": {        "id": "string"      },      "diff": {},      "event_id": "string",      "http_status": 0,      "id": "string",      "item_key": "string",      "kind": "request",      "method": "string",      "object": "audit_entry",      "occurred_at": "2019-08-24T14:15:22Z",      "operation_id": "string",      "origin": {        "client": {          "install_id": "string",          "name": "string",          "version": "string"        },        "ip": "string",        "ip_source": "trusted_proxy",        "user_agent": "string"      },      "outcome": "succeeded",      "path": "string",      "recorded_at": "2019-08-24T14:15:22Z",      "request_id": "string",      "resource": {        "id": "string",        "object": "string"      }    }  ],  "page": {    "limit": 1,    "next_cursor": "string",    "prev_cursor": "string"  }}

Audit entries2

Audit entries in API v3: list audit entries, retrieve an audit entry.

Retrieve an audit entry GET

Retrieves an audit entry by its public ID, which uses the `aud_` prefix (for example, `aud_42`). Malformed IDs and entries that do not exist or are not accessible with the current credentials return `404 Not Found`.