Inbound S3 Logs

An InboundS3Log is an audit log for monitoring and troubleshooting S3-compatible API requests to your Files.com site.

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 Inbound S3 Logs

SDK Method

\Files\Model\InboundS3Log::list;

Return Object

InboundS3Log[]

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 {
  $inbound_s3_logs = \Files\Model\InboundS3Log::list();
  foreach ($inbound_s3_logs as $inbound_s3_log) {
    // Operate on $inbound_s3_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 InboundS3Log Object

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

AttributeDescription
path
string
Request Path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
client_ip
string
Client IP
operation
string
S3 Operation Type
status
string
HTTP Status Code
aws_access_key
string
AWS Access Key ID
error_message
string
Error message, if applicable
error_type
string
Error type, if applicable
duration_ms
int64
Duration (in milliseconds)
request_id
string
Request ID
user_agent
string
User Agent
created_at
date-time
Start Time of Request