v1

latestOpenAPI 3.1.02026-07-245531,0212.1 MB

Audit Trail

List audit trails

Returns audit trail based on the specified filters.

get/audittrail/v1/orgs/{OrgID}/reports/list

Path parameters

OrgIDinteger required

Specify the organization ID of your organization. Set it to "0" to select all organizations. Get the ID of an organization using the 'List all organizations' API.

Query parameters

fromTimestring date-time

Specify the date and time to filter jobs that were run during the specified timestamp. Specify the date and time in UTC format (YYYY-MM-DDTHH:MM:SSZ). The timestamp must be within six months from the current date. For example, if the current date is 2020-10-02, you can specify any date between 2020-04-03 to 2020-10-02.

toTimestring date-time

Specify the date and time to filter jobs that were run until the specified timestamp. Specify the date and time in UTC format. The format is YYYY-MM-DDTHH:MM:SSZ.

resourceType'Configuration' | 'Storage Config' | 'CloudCache' | 'File Server' | 'MS-SQL' | 'VMWare' | 'Disaster Recovery' | 'Device Config' | 'NAS' | 'Hyper-V' | 'Billing' | 'Snowball Edge' | 'Oracle'

Filter audit trails for specific resource type. For example, Files, MS-SQL, CloudCache, VMware, and so on. Specify multiple resource type values by separating them with commas.

entityType'Content Rule' | 'Backup Policy' | 'Backup Set' | 'Admin Group' | 'Admin' | 'Cloud Cache' | 'Seeding' | 'Snowball Edge' | 'DR Proxy' | 'DR Plan' | 'AWS Account' | 'Admin Alert' | 'Admin Report' | 'Non Admin Alert' | 'Non Admin Report' | 'Server' | 'VMWare VM' | 'Backup Proxy' | 'Backup Proxy Pool' | 'VM Auto Config Rule' | 'vCenter ESXi' | 'NAS Device' | 'NAS Proxy' | 'NAS Share' | 'HyperV VM' | 'HyperV Host' | 'HyperV FLR Proxy' | 'Billing Cost Code' | 'Billing Global Cost Allocation Rate' | 'Password Setting' | 'Oraganization' | 'SSO Setting' | 'SQL Availability Group' | 'Backup Store' | 'All Organizations Admin Report' | 'All Organizations Non Admin Report' | 'Geo Fencing'

Filter audit trails for specific entity type. Specify multiple entity type values by separating them with commas.

entityNamestring

Filter audit trails for specific entity name. Specify multiple entity name values by separating them with commas.

action'Update' | 'Create' | 'Delete' | 'Backup Now' | 'Restore' | 'Restore to Original' | 'Restore to Alternate' | 'Delete Snapshot' | 'Delete Cold Snapshot' | 'Defreeze' | 'Log Request' | 'Map' | 'Unmap' | 'Login' | 'Logout' | 'Reset Password' | 'Download Report' | 'Email Report' | 'Enable Backup' | 'Disable Backup' | 'Upgrade' | 'Reconfigure' | 'Re-register' | 'Configure' | 'Unconfigure' | 'Enable DR' | 'Disable DR' | 'Regenerate Token' | 'Decommission Cache' | 'Add Cache Volume' | 'Generate Token' | 'Delete AWS Account' | 'Edit DR Failover Setting' | 'Add VM to DR Plan' | 'Remove VM from DR Plan' | 'Generate SSO Token' | 'Edit SSO Configuration' | 'Add Non Admin Subscription' | 'Update Non Admin Subscription' | 'Delete Non Admin Subscription' | 'Refresh' | 'Trigger DR Failover' | 'Update Credentials' | 'Update DR Copy' | 'Acknowledge' | 'Edit SSO Settings' | 'Reconfigure VM(s) Administrative Group' | 'Reconfigure VM(s) Backup Proxy Pool' | 'Reconfigure VM(s) Proxy Pool' | 'Reconfigure VM(s) Backup Policy' | 'Remove Token' | 'Change Password' | 'Apply Rule(s)' | 'Change Backup Proxy Pool' | 'Ship Back' | 'Snowball Request' | 'Map to Cache' | 'Unmap from Cache' | 'Map for Seeding' | 'Unmap for Seeding' | 'Change Backup Method to RCT' | 'Disable Backup Store' | 'Create Cloud Administrator' | 'Create Organization Administrator' | 'Create Group Administrator' | 'Create Data Protection Officer' | 'Delete Cloud Administrator' | 'Delete Organization Administrator' | 'Delete Group Administrator' | 'Delete Data Protection Officer' | 'Cancel DR Job' | 'DR Failover'

Filter audit trails for specific entity name on which the administrator has performed the action. Specify multiple entity name values by separating them with commas.

adminEmailstring

Filter audit trails for specific action performed by the administrator. For example, Create, Update, Delete, Login, Backup Now, and so on. Specify multiple action values by separating them with commas.

pageTokenstring

Specify the token to access the next page of results. Keep this field blank in the first request. Use the token value received in the previous response's parameter 'nextPageToken'.

Response

Success

nextPageTokenstring

The token to access the next page of results. This parameter will be empty for the last page of results.