External Events

An ExternalEvent is a log that is sent to the cloud from a client application such as the Files.com CLI.

List External Events

SDK Method

files_sdk.external_event.list()

Return Object

ListObj[ExternalEvent]

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:
  external_events = files_sdk.external_event.list()
  for external_event in external_events.auto_paging_iter():
    # Operate on external_event
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)

Show External Event

SDK Method

files_sdk.external_event.find()

Return Object

ExternalEvent

Authorization Requirement

Requires either a Site-Wide API key or User API key or session from a User with Site Admin permissions.

Method Arguments

ArgumentDescription
id
int64
Required		External Event ID.

Example Request

import files_sdk

try:
  external_event = files_sdk.external_event.find(id)
  # Operate on external_event
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)

Create External Event

SDK Method

files_sdk.external_event.create()

Return Object

ExternalEvent

Authorization Requirement

Available to all authenticated keys or sessions.

Method Arguments

ArgumentDescription
status
string
Required		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string
Required		Event body

Example Request

import files_sdk

try:
  external_event = files_sdk.external_event.create({
    "status": "example",
    "body": "example"
  })
  # Operate on external_event
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 ExternalEvent Object

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

AttributeDescription
id
int64		Event ID
event_type
string		Type of event being recorded.
Possible values: ldap_sync, remote_server_sync, lockout, ldap_login, saml_login, client_log, pending_work, siem_http_destination
status
string		Status of event.
Possible values: success, failure, partial_failure, in_progress, skipped
body
string		Event body
created_at
date-time		External event create date/time
body_url
string		Link to log file.