Outbound Connection Logs

An OutboundConnectionLog is an audit log for monitoring and troubleshooting actions performed by your Remote Servers and Files.com on-premise Agents.

Logs available through this endpoint are retained for 6 months, after which they are automatically discarded. For longer retention, use Files.com SIEM integrations to stream logs in real time to your preferred SIEM, or configure SIEM streaming to a file.

List Outbound Connection Logs

SDK Method

\Files\Model\OutboundConnectionLog::list;

Return Object

OutboundConnectionLog[]

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Additional Arguments

Example Request

try {
  $outbound_connection_logs = \Files\Model\OutboundConnectionLog::list();
  foreach ($outbound_connection_logs as $outbound_connection_log) {
    // Operate on $outbound_connection_log
  }
} catch (\Files\NotAuthenticated\InvalidUsernameOrPasswordException $e) {
  echo 'Authentication Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
} catch (\Files\FilesException $e) {
  echo 'Unknown Error Occurred (' . get_class($e) . '): ', $e->getMessage(), "\n";
}

The OutboundConnectionLog Object

Some of the methods above return a OutboundConnectionLog object. The attributes of this object are listed below.

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
path
string		Remote Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
client_ip
string		End User IP
src_remote_server_id
int64		Source Remote Server ID
src_remote_server_name
string		Source Remote Server name
dest_remote_server_id
int64		Destination Remote Server ID
dest_remote_server_name
string		Destination Remote Server name
operation
string		Operation Type
Possible values: copy_file, delete, download_request, home_path, list, list_recursive, list_recursive_with_download, list_with_download, metadata, mkdir, move_file, ping, rmdir_r, upload, upload_finalize, upload_request
error_message
string		Error message, if applicable
error_operation
string		Error operation, if applicable
error_type
string		Error type, if applicable
status
string		Status
Possible values: complete, error
duration_ms
int64		Duration (in milliseconds)
bytes_uploaded
int64		Data Length in Bytes. Present for upload actions that transfer data.
bytes_downloaded
int64		Data Length in Bytes. Present for download actions that transfer data.
list_count
int64		Number of entries returned for a folder list action.
created_at
date-time		Start Time of Action