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

Command

files-cli exavault-api-request-logs list

Output

Outputs a list of ExavaultApiRequestLog objects according to the output format.

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

files-cli exavault-api-request-logs list

The ExavaultApiRequestLog Object

Some of the commands 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