Defines the schema for resources reported on by the audit log.
| API Endpoint | https://api.bigpanda.io/resources/v2.0/audit/logs/ |
|---|---|
| Supported Methods | GET |
BigPanda audit logs report on Create, Update, and Delete actions for these resources:
- Alert Correlation Patterns
- AutoShare Settings
- Environments
- Users
Alert Correlation Pattern Parameters
The correlation_pattern object schema includes the following attributes:
| Attribute | Description | Type | Example |
|---|---|---|---|
| filter | A BPQL query to filter incoming alerts. Only matched alerts will be correlated based on the pattern. | String | "cluster=_prod_"]" |
| cross_source | Determines if alerts can be correlated from different source systems into the same incident Default is false | Boolean | true |
| time_window | Time frame to determine correlation in minutes | Integer | 1-4320 |
| updated_at | The Unix Epoch time that the correlation pattern was last updated. | Timestamp (in seconds) | 1372854204 |
| updated_by | The ID of the user who last updated the correlation pattern | User ID | "3123kjlhfasdlkjfh" |
| active | Whether the pattern should be applied to incoming alerts. | Boolean | true |
| created_at | The Unix Epoch time that the correlation pattern was created | Timestamp (in seconds) | 1493922189 |
| id | System-generated unique identifier for the correlation pattern | String | "12344" |
| created_by | The ID of the user who created the correlation pattern | User ID | "3123kjlhfasdlkjfh" |
| tags | Array of tag name(s) to correlate within the pattern. At least 1 item must appear in the array. No more than 5 items in the array. No duplicate names in the array. | Array | ["service","check"] |
Environment Parameters
The Environment object schema includes the following attributes:
| Attribute | Description | Type | Example |
|---|---|---|---|
| filter | A BPQL query to filter incoming incidents. Only matched incidents will be placed in the environment. | String | "filter":"(source_system = /.*\\..*/ AND zero_impact != \"true\") OR (source_system = \"scout.default\" AND zero_impact != \"true\")" |
| updated_at | The Unix Epoch time that the environment was last updated. | Timestamp (in seconds) | “updated_at":1669032359 |
| created_at | The Unix Epoch time that the environment was created | Timestamp (in seconds) | "created_at":1669031477 |
| name | The name of the environment as displayed in the BigPanda UI | String | "name":"johnny-test-envv" |
| id | System-generated unique identifier for the environment | String | "id":"637b6635c0ec7912005d58f8" |
User Parameters
The User object schema includes the following attributes:
| Attribute | Description | Type | Example |
|---|---|---|---|
| createdAt | The time the user was created. Unix epoch time (in seconds) | Timestamp | 1662284244 |
| lastLoginAt | Unix epoch time when the user last logged in (in seconds) | Timestamp | 1662284244 |
| name | The name of the user as displayed in the BigPanda UI | String | "Betsy Bobbins" |
| id | Unique system identifier for the user | String | "62bc4c139ed3cd00110500da" |
| state | State of the user in system | String | “initial” |
| firstLoginAt | The Unix Epoch time the user first logged in (in seconds) | Timestamp | 1662284244 |
| username | The email address associated with the user | String | "[email protected]" |