PApandorafms
Events

List events

Changed on
post/event/list

Request

  • Base URL
    /api/v2 (relative, and the document was published on a file host, not at the API’s origin)
  • Auth
    HTTP bearer

Query parameters

pageinteger

page

sizePageinteger

Size page

sortFieldstring

sort field

sortDirection'ASC' | 'DESC'

sort direction

Request body

idEventFilterinteger

Id EventFilter

idGroupFilterinteger nullable

Id group filter

namestring

Name of the eventFilter

idGroupinteger nullable

Id group

statusinteger nullable

Event status, the available status are: all, new, validated, inprocess, not_validated, not_in_process

eventType'going_unknown' | 'unknown' | 'alert_fired' | 'alert_recovered' | 'alert_ceased' | 'alert_manual_validation' | 'recon_host_detected' | 'system' | 'error' | 'new_agent' | 'going_up_critical' | 'going_down_critical' | 'going_up_warning' | 'going_down_warning' | 'going_up_normal' | 'going_down_normal' | 'configuration_change' | 'ncm' nullable

Event status, the available status are: going_unknown, unknown, alert_fired, alert_recovered, alert_ceased, alert_manual_validation, recon_host_detected, system, error, new_agent, going_up_critical, going_down_critical, going_up_warning, going_down_warning, going_up_normal, going_down_normal, configuration_change, ncm

searchstring nullable

Search in fields id, event, extraId, source and custom_data

isNotSearchboolean nullable

Not search

textAgentstring nullable

Name agent

idAgentinteger nullable

Id agent

idAgentModuleinteger nullable

Id agent module

paginationinteger nullable

Block size pagination

sliceinteger nullable

Period search events 8h

idUserAckstring nullable

Id user ack

groupByinteger nullable

Event filter group by, the available group by are: all, events, agents, extra_ids

filterOnlyAlertinteger nullable

Event filter event by, the available filter are: all, filter_alert_events, only_alert_events

searchSecondaryGroupsboolean nullable

Search in secondary groups

searchRecursiveGroupsboolean nullable

Search in recursive groups

dateFromstring nullable

Search event registration date

dateTostring nullable

Search event registration date

sourcestring nullable

Search source field

idExtrastring nullable

Search source idExtra

userCommentstring nullable

Search source userComment

idSourceEventinteger nullable

Search id source event

timeFromstring nullable

Search event registration date

timeTostring nullable

Search event registration date

customDatastring nullable

Search custom data

customDataFilterTypeinteger nullable

Event filter event by, the available filter are: all, filter_alert_events, only_alert_events

ownerUserstring nullable

Search owner user

privateFilterUserstring nullable

Search private filter user

regexstring nullable

Search regex

Example request

{
  "dateFrom": "2023-02-21",
  "dateTo": "2023-02-21",
  "timeFrom": "08:34:16",
  "timeTo": "08:34:16"
}

Response

List Events Object

Example response

{
  "data": [
    {
      "timestamp": "2023-02-21 08:34:16"
    }
  ]
}

Changes

  • v2e09afeb73c0cRevision changes
    • breaking

      the / response's property type changed from no type to object for status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • v2d42e8bf36592Revision changes
    • breaking

      the / response's property type changed from object to no type for status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status

    • warning

      removed the optional property // from the response with the status