FTP Action Logs

An FtpActionLog is an audit log for monitoring and troubleshooting operations made to your site through FTP protocol.

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 FTP Action Logs

SDK Method

FtpActionLog.list()

Return Object

FtpActionLog[]

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

import FtpActionLog from 'files.com/lib/models/FtpActionLog';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const ftpActionLogs = await FtpActionLog.list();
  for (const ftpActionLog of ftpActionLogs) {
    // Operate on ftpActionLog
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The FtpActionLog Object

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

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
remote_ip
string		IP Address of FTP Client
server_ip
string		IP Address of FTP Server
username
string		Username
session_uuid
string		Unique ID of the Session
seq_id
int64		FTP Sequence ID
auth_ciphers
string		Authentication Ciphers
action_type
string		Action Type
path
string		Path as sent by the Client (may not match Files.com path due to user root folders for FTP). This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
true_path
string		Path on Files.com
name
string		Name of File
cmd
string		FTP Command Name
param
string		FTP Command Param
responseCode
int64		FTP Response Code
responseMessage
string		FTP Response Message
entries_returned
int64		Number of entries returned when listing files and folders
success
boolean		Whether FTP Action was successful.
status
string		FTP Action status.
Possible values: SUCCESS, FAILURE, PARTIAL_TRANSFER
duration_ms
int64		Duration (in milliseconds)
created_at
date-time		Start Time of Action