After you fetch audit logs, you can analyze them with tools like Pandas, Amazon Redshift, Google BigQuery, or Microsoft Fabric. Some audit log analysis tools don’t support JSON. Refer to the documentation for your analysis tool for guidelines and requirements to transform the JSON-formatted audit logs before analysis.
For more details about the format of the logs, see Audit log schema and Actions.
Audit log retention
The following recommendations help you retain audit logs to meet your organization’s governance and compliance obligations:- If you must retain audit logs for a specific period of time, Weights & Biases recommends periodically transferring logs to long-term storage, either with storage buckets or the Audit Logging API.
- If you are subject to the Health Insurance Portability and Accountability Act of 1996 (HIPAA), you must retain audit logs for a minimum of 6 years in an environment where no internal or external actor can delete or modify them before the end of the mandatory retention period. For HIPAA-compliant Dedicated Cloud instances with BYOB, you must configure guardrails for your managed storage, including any long-term retention storage.
Audit log schema
Use this schema to interpret the fields returned in each audit log entry. The following table shows all keys that can appear in an audit log entry, ordered alphabetically. Depending on the action and the circumstances, a specific log entry may include only a subset of the possible fields.Personally identifiable information (PII)
Personally identifiable information (PII), such as email addresses and the names of projects, teams, and reports, is available only with the API endpoint option:- For Self-Managed and Dedicated Cloud, an organization admin can exclude PII when fetching audit logs.
- For Multi-tenant Cloud, the API endpoint always returns relevant fields for audit logs, including PII. This isn’t configurable.
Before you begin
Before you fetch audit logs, confirm that you meet the following prerequisites for your deployment type:-
Organization-level admins can fetch audit logs. If you receive a
403error, ensure that you or your service account has adequate permission. -
Multi-tenant Cloud: If you’re a member of multiple Multi-tenant Cloud organizations, you must configure the Default API organization, which determines where audit logging API calls are routed. Otherwise, you receive the following error:
To specify your default API organization:
- Click your profile image, then click User Settings.
- For Default API organization, select an organization.
Fetch audit logs
Use the W&B Audit Logging API to retrieve audit logs. The endpoint, query parameters, and response format depend on your deployment type.- Multi-tenant Cloud
- Dedicated Cloud and Self-Managed
Use this tab for Multi-tenant Cloud. Multi-tenant audit logs are available only for Enterprise plans. The Audit Logging API endpoint is:The following query parameters are supported:The response resembles the following example:To fetch the next page, repeat the request with the same resolved date range. Set 1: On Multi-tenant Cloud, audit logs are not collected for:
startDate: The first UTC calendar day in the date range. UseYYYY-MM-DDformat. If you omitstartDate, the range starts at midnight UTC today, ornumDaysdays before today if you setnumDays.numDays: An integer from0through7. Weights & Biases fetches logs fromstartDatethrough the nextnumDaysdays. If you omitnumDaysor set it to0, Weights & Biases fetches logs for one day.limit: The maximum number of audit log entries to return. Use a positive integer up to1,000,000. The default is1,000,000.cursor: An opaque cursor from the previous response’snext_cursorfield. Reuse the cursor with the same resolved date range.
audit_logs: An array of audit log entries. Each entry includes the fields described in Audit log schema.range_start_time: The start of the resolved date range, in UTC.range_end_time: The exclusive end of the resolved date range, in UTC.count: The number of audit log entries returned in this response.next_cursor: An opaque cursor for the next page of results. If this field isnull, there are no more results for the selected date range.
[BASE64-USERNAME-API-KEY]: the base64-encoded string in the format[USERNAME]:[API-KEY].[NEXT-CURSOR]: thenext_cursorvalue from the previous response.
cursor to the next_cursor value from the previous response. Continue until next_cursor is null.- Open or Public projects.
- The
report:readaction. Useractions that aren’t tied to a specific organization.
Use basic authentication
You must authenticate each request to the audit logs API. To use basic authentication with your API key to access the audit logs API, set the HTTP request’sAuthorization header to the string Basic followed by a space, then the base64-encoded string in the format [USERNAME]:[API-KEY]. In other words, replace the username and API key with your values separated with a : character, then base64-encode the result. For example, to authorize as demo:p@55w0rd, set the header to Authorization: Basic ZGVtbzpwQDU1dzByZA==.
Actions
Each audit log entry records one of the following actions. Use this reference to interpret theaction field in a log entry. The following table describes possible actions that Weights & Biases can record, sorted alphabetically.