Sync Logs

A SyncLog is an audit log for monitoring and troubleshooting operations made by Remote Server Sync.

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 Sync Logs

SDK Method

synclog.List()

Return Object

[]*SyncLog

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"
    sync_log "github.com/Files-com/files-sdk-go/v3/synclog"
)

syncLogIterator, err := sync_log.List(files_sdk.SyncLogListParams{})
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 syncLogIterator.Next() {
    syncLog := syncLogIterator.syncLog()
}
err = syncLogIterator.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 SyncLog Object

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

AttributeDescription
Timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
SyncId
int64		Sync ID
ExternalEventId
int64		External Event ID used by legacy syncs
SyncRunId
int64		Sync Run ID
ErrorType
string		Error type, if applicable
Message
string		Message
Operation
string		Operation type
Possible values: delete, delete_source, list, mkdir, sync, sync_overwrite, write_trigger_file
Path
string		File path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
Size
int64		File size
FileType
string		File type
Status
string		Status
Possible values: success, failure, partial_failure, skipped, retried_failure
CreatedAt
date-time		Start Time of Action