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

Command

files-cli external-events list

Output

Outputs a list of ExternalEvent objects according to the output format.

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

files-cli external-events list

Show External Event

Command

files-cli external-events find

Output

Outputs a ExternalEvent object according to the output format.

Authorization Requirement

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

Flags

FlagDescription
--id=
int64
Required		External Event ID.

Example Request

files-cli external-events find \
  --id=1

Create External Event

Command

files-cli external-events create

Output

Outputs a ExternalEvent object according to the output format.

Authorization Requirement

Available to all authenticated keys or sessions.

Flags

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

Example Request

files-cli external-events create \
  --status="example" \
  --body="example"

The ExternalEvent Object

Some of the commands 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.