List User Audit Logs

GET /v1/accounts/{account_id}/auditLogs

List User Audit Logs

cURL

curl --request GET \
  --url https://api.fireworks.ai/v1/accounts/{account_id}/auditLogs \
  --header 'Authorization: Bearer <token>'

200

{
  "auditLogs": [
    {
      "id": "<string>",
      "method": "<string>",
      "principal": "<string>",
      "payload": {},
      "status": {
        "code": "OK",
        "message": "<string>"
      },
      "timestamp": "2023-11-07T05:31:56Z",
      "message": "<string>",
      "resource": "<string>",
      "isAdminAction": true,
      "userAgent": "<string>",
      "clientIp": "<string>",
      "apiKeyId": "<string>"
    }
  ],
  "nextPageToken": "<string>",
  "totalSize": 123
}

Authorizations

Authorization · string · header · required

Bearer authentication using your Fireworks API key. Format: Bearer <API_KEY>

Path Parameters

account_id · string · required

The Account Id

Query Parameters

startTime · string<date-time>

Start time of the audit logs to retrieve. If unspecified, the default is 30 days before now.

endTime · string<date-time>

End time of the audit logs to retrieve. If unspecified, the default is the current time.

email · string

Optional. Filter audit logs for user email associated with the account.

pageSize · integer<int32>

The maximum number of audit logs to return. The maximum page_size is 200, values above 200 will be coerced to 200. If unspecified, the default is 10.

pageToken · string

A page token, received from a previous ListAuditLogs call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to ListAuditLogs must match the call that provided the page token.

filter · string

Optional. An AIP-160 filter expression (https://google.aip.dev/160) over the fields message, resource, email, api_key_id, event_type, and target_api_key_id. Use = for an exact match and : for a substring match, for example email="[e-mail]" or message:"Create".

orderBy · string

Unused. Audit log entries are always returned ordered by timestamp descending (newest first).

readMask · string

The fields to be returned in the response. If empty or "*", all fields will be returned.

Response

200 - application/json

A successful response.

auditLogs · object[]

Matching audit log entries. May be empty while nextPageToken is still set, which means the scan has not reached matching entries yet rather than that there are no results. This list may also be shorter than page_size.

Show child attributes

nextPageToken · string

A token, which can be sent as page_token to retrieve the next page. If this field is omitted, there are no subsequent pages. This is the only signal that results are exhausted: an empty auditLogs list or a short page does not mean the scan is finished.

totalSize · integer<int32>

Always 0 for audit logs. The number of matching entries is not known until the scan completes, so this field cannot be used to size a loop or compute a page count.