List audit logs

API for searching audit logs. Limited to at most 30 day search, returns up to 100 records per page. Not recommended for bulk export.

GET/audit-logs

API for searching audit logs. Limited to at most 30 day search, returns up to 100 records per page. Not recommended for bulk export.

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Query Parameters

start*string

Lower bound (inclusive) for the audit record timestamp.

Formatdate-time
end*string

Upper bound (exclusive) for the audit record timestamp.

Formatdate-time
auth_strategy?string

Filter by authentication strategy.

service?string

Filter by service name.

method?string

Filter by HTTP method.

exclude_method?array<string>

Filter out results by HTTP method.

Itemsitems <= 10
search?string

Free-text search over path, user ID, email, client IP, and status.

search_user_id?array<string>

Additional user IDs to OR into free-text search.

Itemsitems <= 100
limit?integer

Maximum number of results to return.

Range1 <= value <= 100
Default100
page_token?string

Opaque page token from X-Next-Page-Token for the next page of older records.

Response

application/json

A list of audit log records.

[index: integer]?
curl -X GET "https://example.com/audit-logs?start=2019-08-24T14%3A15%3A22Z&end=2019-08-24T14%3A15%3A22Z"
[  {    "timestamp": "2019-08-24T14:15:22Z",    "auth_strategy": "string",    "user_id": "string",    "email": "string",    "status": 0,    "method": "string",    "path": "string",    "route": "string",    "domain": "string",    "duration_ms": 0,    "client_ip": "string",    "user_agent": "string"  }]