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

Endpoint

GET/file_migration_logs

Return Object

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

curl https://app.files.com/api/rest/v1/file_migration_logs.json \
  -H 'X-FilesAPI-Key: YOUR_API_KEY'

Example Response

[
  {
    "timestamp": "2000-01-01T01:00:00Z",
    "file_migration_id": 1,
    "dest_path": "example",
    "error_type": "example",
    "message": "example",
    "operation": "example",
    "path": "example",
    "status": "example",
    "created_at": "2000-01-01T01:00:00Z"
  }
]

The FileMigrationLog Object

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

Example FileMigrationLog Object

{
  "timestamp": "2000-01-01T01:00:00Z",
  "file_migration_id": 1,
  "dest_path": "example",
  "error_type": "example",
  "message": "example",
  "operation": "example",
  "path": "example",
  "status": "example",
  "created_at": "2000-01-01T01:00:00Z"
}