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

exavaultapirequestlog.List()

Return Object

[]*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

import (
    "fmt"
    "errors"

    files_sdk "github.com/Files-com/files-sdk-go/v3"
    exavault_api_request_log "github.com/Files-com/files-sdk-go/v3/exavaultapirequestlog"
)

exavaultApiRequestLogIterator, err := exavault_api_request_log.List(files_sdk.ExavaultApiRequestLogListParams{})
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

for exavaultApiRequestLogIterator.Next() {
    exavaultApiRequestLog := exavaultApiRequestLogIterator.exavaultApiRequestLog()
}
err = exavaultApiRequestLogIterator.Err()
if err != nil {
    var respErr files_sdk.ResponseError
    if errors.As(err, &respErr) {
        fmt.Println("Response Error Occurred (" + respErr.Type + "): " + respErr.ErrorMessage)
    } else {
        fmt.Printf("Unexpected Error: %s\n", err.Error())
    }
}

The ExavaultApiRequestLog Object

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

Attribute	Description
Timestamp date-time	Start Time of Action. Deprecrated: Use created_at.
Endpoint string	Name of API Endpoint
Version double	Exavault API Version
RequestIp string	IP of requesting client
RequestMethod string	HTTP Method
ErrorType string	Error type, if applicable
ErrorMessage string	Error message, if applicable
UserAgent string	User-Agent
ResponseCode int64	HTTP Response Code
Success boolean	`false` if HTTP Response Code is 4xx or 5xx
DurationMs int64	Duration (in milliseconds)
CreatedAt date-time	Start Time of Action