Sign in
Events

List events

post/event/list

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

Changed in 2 of the 3 revisions of this API.22424

  • v2e09afeb73c0c124See the full diff
    • ▲

      the data/items/ response's property type/format changed from / to object/ for status 200

      response-property-type-changed

    • ○

      added the optional property data/items/ackUtimestamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/criticalInstructions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/customData to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/data to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/event to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/eventCustomId to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/eventType to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idAgent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idAgentModule to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idAlertAm to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idEvent to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idExtra to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idGroup to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/idUser to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/moduleStatus to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/ownerUser to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/severity to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/source to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/tags to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/timestamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/unknownInstructions to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/utimestamp to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property data/items/warningInstructions to the response with the 200 status

      response-optional-property-added

  • v2d42e8bf36592124See the full diff
    • ▲

      the data/items/ response's property type/format changed from object/ to / for status 200

      response-property-type-changed

    • ●

      removed the optional property data/items/ackUtimestamp from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/criticalInstructions from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/customData from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/data from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/event from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/eventCustomId from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/eventType from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idAgent from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idAgentModule from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idAlertAm from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idEvent from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idExtra from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idGroup from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/idUser from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/moduleStatus from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/ownerUser from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/severity from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/source from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/status from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/tags from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/timestamp from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/unknownInstructions from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/utimestamp from the response with the 200 status

      response-optional-property-removed

    • ●

      removed the optional property data/items/warningInstructions from the response with the 200 status

      response-optional-property-removed

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog