File Migration Logs

A FileMigrationLog is an audit log for monitoring and troubleshooting File Migrations in your 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 File Migration Logs

SDK Method

files_sdk.file_migration_log.list()

Return Object

ListObj[FileMigrationLog]

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 files_sdk

try:
  file_migration_logs = files_sdk.file_migration_log.list()
  for file_migration_log in file_migration_logs.auto_paging_iter():
    # Operate on file_migration_log
except files_sdk.error.NotAuthenticatedError as err:
  print(f"Authentication Error Occurred ({type(err).__name__}):", err)
except files_sdk.error.Error as err:
  print(f"Unknown Error Occurred ({type(err).__name__}):", err)

The FileMigrationLog Object

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

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
file_migration_id
int64		File Migration ID
dest_path
string		Destination path, for moves and copies
error_type
string		Error type, if applicable
message
string		Message
operation
string		Operation type
Possible values: copy, delete, delete_for_overwrite, mkdir, move, organize, regional_migration
path
string		File path. This must be slash-delimited, but it must neither start nor end with a slash. Maximum of 5000 characters.
status
string		Status
Possible values: success, failure, skipped, retried_failure
created_at
date-time		Start Time of Action