Exavault API Request Logs

An ExavaultApiRequestLog is an audit log for monitoring and troubleshooting requests to the ExaVault API.

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 Exavault API Request Logs

SDK Method

Files::ExavaultApiRequestLog.list

Return Object

List<ExavaultApiRequestLog>

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

begin
  exavault_api_request_logs = Files::ExavaultApiRequestLog.list
  exavault_api_request_logs.auto_paging_each do |exavault_api_request_log|
    # Operate on exavault_api_request_log
  end
rescue Files::NotAuthenticatedError => e
  puts "Authentication Error Occurred (#{e.class.to_s}): " + e.message
rescue Files::Error => e
  puts "Unknown Error Occurred (#{e.class.to_s}): " + e.message
end

The ExavaultApiRequestLog Object

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

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
endpoint
string		Name of API Endpoint
version
double		Exavault API Version
request_ip
string		IP of requesting client
request_method
string		HTTP Method
error_type
string		Error type, if applicable
error_message
string		Error message, if applicable
user_agent
string		User-Agent
response_code
int64		HTTP Response Code
success
boolean		false if HTTP Response Code is 4xx or 5xx
duration_ms
int64		Duration (in milliseconds)
created_at
date-time		Start Time of Action