audit-logs

List audit logs

When neither from nor to is supplied, results default to the last 7 days (the audit log is append-only and an unbounded scan would hit the entire table). Pass an explicit from for older entries.

get/admin/v1/audit-logs

Request

  • Base URL: / (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /admin/v1/audit-logs
  • Auth: HTTP bearer

Query parameters

actor_type'user' | 'api_key' | 'service_account' | 'external_user' | 'system'

Type of actor that performed an action

Filter by actor type

actor_idstring uuid nullable

Filter by actor ID

actionstring nullable

Filter by action (e.g., "api_key.create")

resource_typestring nullable

Filter by resource type (e.g., "api_key")

resource_idstring uuid nullable

Filter by resource ID

org_idstring uuid nullable

Filter by organization ID

project_idstring uuid nullable

Filter by project ID

fromstring date-time nullable

Start of time range (inclusive)

tostring date-time nullable

End of time range (exclusive)

limitinteger nullable

Maximum number of results to return

cursorstring nullable

Cursor for pagination (cursor-based pagination)

directionstring nullable

Pagination direction (forward or backward). Only used with cursor.

Response

List of audit log entries (defaults to the last 7 days when no from/to range is given)

Example response

{
  "pagination": {
    "has_more": true,
    "limit": 100,
    "next_cursor": "MTczMzU4MDgwMDAwMDphYmMxMjM0NS02Nzg5LTAxMjMtNDU2Ny0wMTIzNDU2Nzg5YWI"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.