external_events
External Events

Create External Event

Changed on

Create External Event

post/external_events

Request

  • Base URL
    https://app.files.com/api/rest/v1
  • URL
    https://app.files.com/api/rest/v1/external_events
  • Auth
    none declared

Request body multipart/form-data

status'success' | 'failure' | 'partial_failure' | 'in_progress' | 'skipped' required

Status of event.

bodystring required

Event body

Example request

{
  "status": "example",
  "body": "example"
}

Response

The ExternalEvents object.

idinteger

Event ID

workspace_idinteger

Workspace ID

event_type'ldap_sync' | 'remote_server_sync' | 'lockout' | 'ldap_login' | 'saml_login' | 'client_log' | 'pending_work' | 'siem_http_destination'

Type of event being recorded.

status'success' | 'failure' | 'partial_failure' | 'in_progress' | 'skipped'

Status of event.

bodystring

Event body

created_atstring date-time

External event create date/time

body_urlstring

Link to log file.

Example response

{
  "id": 1,
  "workspace_id": 1,
  "event_type": "example",
  "status": "example",
  "body": "example",
  "created_at": "2000-01-01T01:00:00Z",
  "body_url": "example"
}

Changes