Automation Logs

An AutomationLog is an audit log for monitoring and troubleshooting triggered Automation.

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

SDK Method

AutomationLog.list()

Return Object

AutomationLog[]

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 AutomationLog from 'files.com/lib/models/AutomationLog';
import * as FilesErrors from 'files.com/lib/Errors';

try {
  const automationLogs = await AutomationLog.list();
  for (const automationLog of automationLogs) {
    // Operate on automationLog
  }
} catch (err) {
  if (err instanceof FilesErrors.NotAuthenticatedError) {
    console.error(`Authentication Error Occurred (${err.constructor.name}): ${err.error}`);
  } else if (err instanceof FilesErrors.FilesError) {
    console.error(`Unknown Error Occurred (${err.constructor.name}): ${err.error}`);
  } else {
    throw err;
  }
}

The AutomationLog Object

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

AttributeDescription
timestamp
date-time		Start Time of Action. Deprecrated: Use created_at.
automation_id
int64		Automation ID
automation_run_id
int64		Automation Run ID
correlation_id
string		Logical item correlation ID
dest_path
string		Destination path, for moves and copies
error_type
string		Typed error, if applicable
source_automation_id
int64		ID of the Automation whose definition owns this node
source_automation_version
int64		Pinned version of the Automation whose definition owns this node
message
string		Message
node_id
string		Node ID
node_type
string		Node type
operation
string		Operation type
Possible values: as2_send, copy, delete, import_file, items_emitted, mkdir, move, node_finished, node_started, perform_as2_send, run_sync, save_url, wait
output
string		Node outlet used by the item
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