FIfiles
file_migrations
File Migrations

Show File Migration

Changed on

Show File Migration

get/file_migrations/{id}

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/file_migrations/{id}
  • Auth
    none declared

Path parameters

idinteger required

File Migration ID.

Response

The FileMigrations object.

idinteger

File migration ID

pathstring

Source path

dest_pathstring

Destination path

failure_messagestring

Reason for the failure, if applicable.

files_movedinteger

Number of files processed

files_totalinteger
operation'delete' | 'move' | 'copy' | 'regional_migration' | 'organize' | 'zip' | 'unzip' | 'gpg_encrypt' | 'gpg_decrypt' | 'transform'

The type of operation

regionstring

Region

status'pending' | 'cancelled' | 'processing' | 'completed' | 'failed'

Status

log_urlstring

Link to download the log file for this migration.

Example response

{
  "id": 1,
  "path": "MyFolder",
  "dest_path": "MyFolder",
  "failure_message": "example",
  "files_moved": 1,
  "files_total": 1,
  "operation": "move",
  "region": "USA",
  "status": "complete",
  "log_url": "https://www.example.com/log_file"
}

Changes