Logs
Files.com maintains comprehensive audit logs of who, what, when, where, and how your files are modified.
This information can be accessed and retrieved in various locations using several methods.
Generally speaking, audit logs, and similar reporting information, are categorized into several topics.
Description | |
---|---|
Settings and Configurations | Shows changes made to site-wide settings and configurations, and changes made to folder settings. |
Site activity history | Shows site-wide activity of files, user accounts, groups, logins, permissions, and API Keys. |
User activity history | Shows the selected user's activity. Includes file and folder activity by the user, login attempts by the user, and changes made to the user account by an administrator. |
Folder activity history | Shows the selected folder's activity. Includes file and folder activity performed within the selected folder. |
Share Link usage | Shows the download activity for the selected Share Link. |
Inbox usage | Shows the upload activity for the selected Inbox. |
Inbox registrations | Shows details of the user registrations for the selected Inbox. |
External events | Shows events that occurred when interacting with external systems. Includes Remote Servers, external identity systems (LDAP, SAML), and the Files.com CLI App. |
Webhook activity | Shows the results of webhook calls made from your Files.com site to other systems. |
Automation activity | Shows the actions performed by the selected automation and their results. |
AS2 transmissions | Shows the inbound and outbound AS2 transmissions between your Files.com site and your AS2 trading partners. Includes Message Disposition Notification (MDN) information. |
Site usage | Shows site-wide utilization of storage, bandwidth, APIs, and user accounts of your Files.com site. |
This log shows the changes made to site-wide settings and configurations, and changes made to folder settings.
It includes changes made by administrators to various settings, such as your site branding, custom domain information, global file expiration settings, storage regions, remote servers, user accounts, automations, and folder settings.
Folder settings changes include Inbox settings, Remote Server Mount configuration, Remote Server Sync configuration, Webhook configuration, Publicly Serve configuration, file extension restrictions, and other folder settings.
Web UI
Type Settings Changes in the search bar at the top of any page, then click on the matching result.
API
The information in the Settings Changes log can be retrieved programmatically using the List Settings Changes API.
CLI
You can use the Files.com CLI App to retrieve the information in the Settings Changes log by using the following command options:
files-cli settings-changes list
This log shows the site-wide activity of files, user accounts, groups, logins, permissions, and API Keys. We retain these logs for 7 years.
It includes items, such as when:
- Files are created, read, updated, deleted, moved, and copied.
Note: Some types of file actions are not associated with a particular user, such as when an external contact uploads to an inbox, or downloads from a share link. - User accounts are created, updated, and deleted.
- Groups are created, updated, and deleted.
- A login attempt succeeds or fails.
Note: Not every login activity is included for protocols such as FTP, SFTP and Webdav. Many FTP clients re-connect multiple times for a single user action. Repeated logins from the same IP and protocol within a small timeframe are therefore consolidated to improve readability of the logs. - Permission to a folder is added or removed.
- API keys are created, updated, and deleted.
Web UI
To can access the Site Activity History log within the Files.com web UI, type History in the search bar at the top of every page, then click on the matching result.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
The Export button, at the top right of the page, allows you to export the data in CSV (comma separated text) format.
The Filter button, at the top right of the page, allows you to filter the displayed results by date range, action, user, folder path, file path, and IP address.
API
The information in the Site Activity History log can be retrieved programmatically using the Show History Export API.
CLI
You can use the Files.com CLI App to retrieve the information in the Site Activity History log by using the following command options:
files-cli histories list --start-at "2022-07-01T08:00:00Z" --end-at "2022-07-08T17:30:00Z" --format csv
This log shows the activity of the selected user as well as changes made to the selected user account by an administrator. We retain these logs for 7 years.
It includes items, such as when:
- Files are created, read, updated, deleted, moved, copied, and downloaded by this user.
- This user's account is created, updated, or deleted by an administrator.
- A login attempt succeeds or fails for this user.
Note: Not every login activity is included for protocols such as FTP, SFTP and Webdav. Many FTP clients re-connect multiple times for a single user action. Repeated logins from the same IP and protocol within a small timeframe are therefore consolidated to improve readability of the logs.
Web UI
To access a user's activity history, edit the user, then click the History tab.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
The Export button, at the top right of the page, allows you to export the data in CSV (comma separated text) format.
The Filter button, at the top right of the page, allows you to filter the displayed results by date range, IP address, and interface used.
API
The information in the User Activity History log can be retrieved programmatically using the List History For Specific User API.
CLI
You can use the Files.com CLI App to retrieve the information in the User Activity History log by using the following commands.
First, use this command to list the users and capture the USER-ID of the user that you want to target:
files-cli users list
Then, use this command to retrieve the log information of the specified user (making sure to replace <USER-ID> with the numeric ID returned from the prior command above):
files-cli histories list-for-user --user-id <USER-ID>
This log shows the file and folder activity performed within the selected folder. We retain these logs for 7 years.
It includes items, such as:
- When files are created, read, updated, deleted, moved, copied, and downloaded.
- When folders are created, updated, deleted, renamed (moved), and copied.
- The user that performed the action.
Web UI
You can access the Folder Activity History log within the Files.com web UI by navigating to Files > selected folder > File history.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
The Filter button, at the top right of the page, allows you to filter the displayed results by date range, action, user, IP address, and interface used.
API
The information in the Folder Activity History log can be retrieved programmatically using the List History For Specific Folder API.
CLI
You can use the Files.com CLI App to retrieve the information in the Folder Activity History log by using the following command options:
files-cli histories list-for-folder --path path/to/folder
This log shows the download activity for the selected Share Link. Only downloads are included in the activity; if a share link recipient visits the share link but does not download, there will be no activity recorded for them in this log. For this reason, share links set to "Preview Only" mode will not display any activity in the log. We retain these logs for 1 year.
It includes items, such as:
- Which files were downloaded.
- Whether the download method was for an individual file or for a ZIP file containing all the files and folders.
- The registered user that performed the action, if registration was required for the Share Link.
Web UI
To view the Share Link Usage log in the Files.com web UI, edit the Share Link's settings and click the Access Logs tab.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
API
The information in the Share Link Usage log can be retrieved programmatically using the List Bundle Downloads API.
CLI
You can use the Files.com CLI App to retrieve the information in the Share Link Usage log by using the following commands.
First, use this command to list the Share Links (bundles) and capture the ID of the Share Link (bundle) that you want to target:
files-cli bundles list
Then, use this command to access the Share Link (bundle) access log of the specified Share Link (making sure to replace <ID> with the correct ID returned from the prior command above):
files-cli bundle-downloads list --bundle-id <ID>
File activity generated by external contacts using Share Links is also captured in the Site Activity History, but because it is not associated with a logged-in user, no username will appear in the Site Activity History for this type of activity.
This log shows the upload activity for the selected Inbox. We retain these logs for 1 year.
It includes items, such as:
- Which files were uploaded, including the folder path to where they were uploaded.
- The registered user that performed the action, if registration was required for the Inbox.
Web UI
To view the Inbox Usage log in the Files.com web UI, edit the Inbox's settings and click the Access Logs tab.
API
The information in the Inbox Usage log can be retrieved programmatically using the Inbox Uploads API.
CLI
You can use the Files.com CLI App to retrieve the information in the Inbox Usage log by using the following commands.
First, use this command to list the Inboxes (folder behavior of the type "inbox") and capture the ID of the Inbox (behavior) that you want to target:
files-cli behaviors list --behavior inbox
Then, use this command to access the Inbox (behavior) access log of the specified Inbox (making sure to replace <ID> with the correct ID returned from the prior command above):
files-cli inbox-uploads list --inbox-id <ID>
Uploads to inboxes are also captured in the Site Activity History. Because these actions are not associated with a logged-in user, the username in the Site Activity History will be blank.
This log shows details of the user registrations for the selected Inbox. We retain these logs for 1 year.
It includes items, such as:
- The responses provided by the user to the input fields of the registration form used for this Inbox.
- The ClickWrap used for the registration, if one was required for the Inbox.
The standard input fields for a registration form are Name, Email Address, and Company Name. If a Custom Form is used for the Inbox registration, then the field names will match those used in the Custom Form and the responses to the custom input fields will be included in the log.
Web UI
To view the Inbox Registrations log in the Files.com web UI, edit the Inbox's settings and click the Registrations tab.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
API
The information in the Inbox Registrations log can be retrieved programmatically using the List Inbox Registrations API.
CLI
You can use the Files.com CLI App to retrieve the information in the Inbox Registrations log by using the following commands.
First, use this command to list the Inboxes (folder behavior of the type "inbox") and capture the ID of the Inbox (behavior) that you want to target:
files-cli behaviors list --behavior inbox
Then, use this command to access the Inbox Registrations log of the specified Inbox (making sure to replace <ID> with the correct ID returned from the prior command above):
files-cli inbox-registrations list --folder-behavior-id <ID>
This log shows events that occurred when interacting with external systems, including Remote Servers, external identity systems (LDAP, SAML), and the Files.com CLI App. We retain these logs for 30 days.
It includes items, such as:
- The logs sent from the Files.com CLI App, showing uploads and downloads that were performed by the CLI App.
- Login attempts, login successes, and login failures for users that are configured with LDAP or SAML for authentication.
- Synchronization events from an external LDAP system to your Files.com account.
- Remote Server synchronization events, such as scheduled pushes and pulls of files and folders between Files.com and the remote server.
Web UI
To access the External Events log within the Files.com web UI, type External logs in the search bar at the top of each page, and then click on the matching result.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
The Filter button, at the top right of the page, allows you to filter the displayed results by date range, event type, status, and remote server type.
API
The information in the External Events log can be retrieved programmatically using the List External Events API.
CLI
You can use the Files.com CLI App to retrieve the information in the External Events log by using the following command.
files-cli external-events list
This log shows the results of webhook calls made from your Files.com site to other systems. We retain these logs for 30 days.
It includes items, such as:
- The file that triggered the webhook.
- The folder where the file was located. This folder contains the configuration for this webhook.
- .The URL that the webhook called.
- The HTTP request method that was used. For example, POST or GET.
- The HTTP request headers that were sent.
- The HTTP response code that was returned from the remote API.
- The HTTP response message that was returned from the remote API.
Web UI
To access the Webhook Activity log within the Files.com web UI, type Webhook logs in the search bar at the top of each page, and then click on the matching result.
The Columns button, at the top right of the page, allows you to specify which columns should be displayed.
The Export button, at the top right of the page, allows you to export the data in CSV (comma separated text) format.
The Filter button, at the top right of the page, allows you to filter the displayed results by date range, file path, folder path, method, status, success, message, and request URL.
API
The information in the Webhook Activity log can be retrieved programmatically using the Create Action Notification Export API.
CLI
You can use the Files.com CLI App to retrieve the information in the Webhook Activity log by using the following commands.
First, use this command to create the log export, and capture the ID of the export:
files-cli action-notification-exports create --start-at "2022-07-01T08:00:00Z" --end-at "2022-07-08T17:30:00Z"
Then, use this command to access the Webhook Activity log of the specified export (making sure to replace <ID> with the correct ID returned from the prior command above):
files-cli action-notification-export-results list --action-notification-export-id <ID>
This log shows the actions performed, and their results, of the selected automation. We retain these logs for 30 days.
Possible actions can include copy, move, delete, create folder, and request file.
This log, and the Details button for each entry, includes items, such as:
- The ending status of the automation run.
- The start time of the run.
- The end time of the run.
- The actions (operation) that were performed.
- Any response messages.
- The source path of the item or file that was affected.
- The destination path of the item or file that was affected.
Web UI
You can access the Automation Activity log within the Files.com web UI by editing the Automation settings and selecting the Run Logs tab. The Details button provides information about the actions that occurred during this run of the automation.
The Filter button, at the top right of the page, allows you to filter the displayed results by status.
API
The information in the Automation Activity log can be retrieved programmatically using the List Automation Runs API.
CLI
You can use the Files.com CLI App to retrieve the information in the Automation Activity log by using the following commands.
First, use this command to list the automations, and capture the ID of the automation that you want to target:
files-cli automations list
Then, use this command to access the Automation Activity log of the specified automation (making sure to replace <ID> with the correct ID returned from the prior command above):
files-cli automation-runs list --automation-id <ID>
If you need the detailed information for each step of the automation, then use the STATUS_MESSAGES_URL that was returned in the above command, and retrieve the details from it using a web browser or a GET web request.
This log shows the inbound and outbound AS2 transmissions between your Files.com site and your AS2 trading partners. It includes Message Disposition Notification (MDN) information, if it is available. We retain these logs for 30 days.
This log includes items, such as:
- The transmission direction, Inbound or Outbound.
- The sender's Trading Partner ID.
- The recipient's Trading Partner ID.
- The end status of the transmission, for example success or failure.
- The size of the transmitted file.
- The file name.
- A link to the file contents, if available.
- An indication of whether a Message Disposition Notification (MDN) exists for the transfer.
- A link to view the Message Disposition Notification (MDN), if it exists.
- The results of the AS2 processing steps to receive, decrypt, verify the digital signature of the file, and send back a Message Disposition Notification (MDN).
- The AS2 HTTP Response Code
- The AS2 HTTP Response Headers
Web UI
To access the AS2 Transmissions log within the Files.com web UI, type AS2 logs in the search bar at the top of each page, and then click on the matching result.
The Columns button, at the top right of each table, allows you to specify which columns should be displayed.
The Filter button, at the top right of each table, allows you to filter the displayed results by date range and AS2 trading partner.
API
The information in the AS2 Transmissions logs can be retrieved programmatically using the List AS2 Incoming Messages API and the List AS2 Outgoing Messages API.
CLI
You can use the Files.com CLI App to retrieve the information in the AS2 Transmissions logs by using the following commands.
Use this command to list the Incoming AS2 transmissions:
files-cli as2-incoming-messages list
Use this command to list the Outgoing AS2 transmissions:
files-cli as2-outgoing-messages list
This log shows the site-wide utilization of storage, bandwidth, APIs, and user accounts of your Files.com site.
Web UI
To access the Site Usage information within the Files.com web UI, type Usage in the search bar at the top of each page, and then click on the matching result. The information is presented visually and can be interacted with to specify the date range and chart type.
API
The information in the Site Usage information can be retrieved programmatically using the List Site Usage API.
CLI
You can use the Files.com CLI App to retrieve the Site Usage information by using the following command:
files-cli usage-snapshots list
Get Instant Access to Files.com
The button below will take you to our Free Trial signup page. Click on the white "Start My Free Trial" button, then fill out the short form on the next page. Your account will be activated instantly. You can dive in and start yourself or let us help. The choice is yours.
Start My Free Trial