Use the Audit Logs API to report on changes made to BigPanda resources
Audit logs enable admins to keep track of changes in their configuration and settings across the BigPanda platform. The Audit Logs API gives admins a vital troubleshooting, investigation, and security tool.
BigPanda audit logs report on Create, Update, and Delete actions for these resources:
- Enrichment V1 Custom Tags
- Correlation Patterns
- Environments
- Users
- Alert Enrichment including:
- Tags
- Tags Order
- Tag Enrichments
- Tag Enrichments Order
- Mapping Enrichment Schema
- Mapping Table Upload
Users Object
Currently, the audit log does not track changes to user phone or name, and returns limited data on role changes. In the future more details will be added to the Users audit log.
Read more about what fields are included in the Users Object Parameters.
Relevant Permissions
Roles with the following permission can access the Audit Logs API:
| Name | Description |
|---|---|
| Audit Logs | View the Audit Log in BigPanda Settings and the Audit Lot API. |
Permission access levels can be adjusted by selecting either View or Full Access. To learn more about how BigPanda's permissions work, see the Roles Management guide.
Authentication
All BigPanda APIs require Bearer Token Authorization in the call headers.
This API uses the User API Key type of Authorization token.
Rate Limitations
To maintain quality of service, BigPanda APIs are limited to 5 requests per second.
Additional requests will return a 429 response code and the request will need to be retried.
Available Actions
Use the Audit Logs API to perform these actions:
| Action | Definition | Description |
|---|---|---|
| Retrieve All Audit Logs | GET /audit/logs | Retrieves specific records for an Audit Log schema. |