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

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

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

try {
  const inboundS3Logs = await InboundS3Log.list();
  for (const inboundS3Log of inboundS3Logs) {
    // Operate on inboundS3Log
  }
} 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 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