Sign in

v4

latestSwagger 2.02026-08-0343714211.7 MB
external_events
External Events

List External Events

List External Events

get/external_events

Query parameters

cursorstring

Used for pagination. When a list request has more records available, cursors are provided in the response headers X-Files-Cursor-Next and X-Files-Cursor-Prev. Send one of those cursor value here to resume an existing list from the next available record. Note: many of our SDKs have iterator methods that will automatically handle cursor-based pagination.

per_pageinteger

Number of records to show per page. (Max: 10000, 1,000 or less is recommended).

If set, sort records by the specified field in either asc or desc direction. Valid fields are created_at, status or event_type.

If set, return records where the specified field is equal to the supplied value. Valid fields are created_at and status. Valid field combinations are [ status, created_at ].

If set, return records where the specified field is greater than the supplied value. Valid fields are created_at.

If set, return records where the specified field is greater than or equal the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than the supplied value. Valid fields are created_at.

If set, return records where the specified field is less than or equal the supplied value. Valid fields are created_at.

Response

A list of ExternalEvents objects.

idinteger

Event 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,
    "event_type": "example",
    "status": "example",
    "body": "example",
    "created_at": "2000-01-01T01:00:00Z",
    "body_url": "example"
  }
]