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

Endpoint

GET/outbound_connection_logs

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

curl https://app.files.com/api/rest/v1/outbound_connection_logs.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "timestamp": "2000-01-01T01:00:00Z",
    "path": "example",
    "client_ip": "example",
    "src_remote_server_id": 1,
    "src_remote_server_name": "example",
    "dest_remote_server_id": 1,
    "dest_remote_server_name": "example",
    "operation": "example",
    "error_message": "example",
    "error_operation": "example",
    "error_type": "example",
    "status": "complete",
    "duration_ms": 1,
    "bytes_uploaded": 1,
    "bytes_downloaded": 1,
    "list_count": 1,
    "created_at": "2000-01-01T01:00:00Z"
  }
]

The OutboundConnectionLog Object

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

Attribute	Description
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

Example OutboundConnectionLog Object

{
  "timestamp": "2000-01-01T01:00:00Z",
  "path": "example",
  "client_ip": "example",
  "src_remote_server_id": 1,
  "src_remote_server_name": "example",
  "dest_remote_server_id": 1,
  "dest_remote_server_name": "example",
  "operation": "example",
  "error_message": "example",
  "error_operation": "example",
  "error_type": "example",
  "status": "complete",
  "duration_ms": 1,
  "bytes_uploaded": 1,
  "bytes_downloaded": 1,
  "list_count": 1,
  "created_at": "2000-01-01T01:00:00Z"
}