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

Endpoint

GET/inbound_s3_logs

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

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

Example Response

[
  {
    "path": "example",
    "client_ip": "example",
    "operation": "example",
    "status": "example",
    "aws_access_key": "example",
    "error_message": "example",
    "error_type": "example",
    "duration_ms": 1,
    "request_id": "example",
    "user_agent": "example",
    "created_at": "2000-01-01T01:00:00Z"
  }
]

The InboundS3Log Object

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

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

Example InboundS3Log Object

{
  "path": "example",
  "client_ip": "example",
  "operation": "example",
  "status": "example",
  "aws_access_key": "example",
  "error_message": "example",
  "error_type": "example",
  "duration_ms": 1,
  "request_id": "example",
  "user_agent": "example",
  "created_at": "2000-01-01T01:00:00Z"
}