PApandorafms
Events

Updates an event

Changed on
put/event/{idEvent}

Request

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

Path parameters

idEventinteger required

Event id

Request body

idEventinteger

Id event

idAgentinteger nullable

Id agent

idUserstring nullable

Id user

idGroupinteger nullable

Id group

statusinteger

Event status, the available status are: new, validated, inprocess

timestampstring nullable

Event registration date

eventstring

Description event

utimestampinteger nullable

Event registration date

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'

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

idAgentModuleinteger nullable

Id agent module

idAlertAminteger nullable

Id alert action

severityinteger

Event severity, the available severity are: maintenance, informational, normal, warning, critical, minor, major

tagsstring nullable

Tags

sourcestring nullable

Source

idExtrastring nullable

Extra id

criticalInstructionsstring nullable

Critical instructions

warningInstructionsstring nullable

Warning instructions

unknownInstructionsstring nullable

Unknows instructions

ownerUserstring nullable

Id user

ackUtimestampinteger nullable

Event ack utimestamp

customDatastring nullable

Custom data

datastring nullable

Data

moduleStatusinteger nullable

Module status

eventCustomIdstring nullable

Events Custom Id

Example request

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

Response

Event object

idEventinteger

Id event

idAgentinteger nullable

Id agent

idUserstring nullable

Id user

idGroupinteger nullable

Id group

statusinteger

Event status, the available status are: new, validated, inprocess

timestampstring nullable

Event registration date

eventstring

Description event

utimestampinteger nullable

Event registration date

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'

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

idAgentModuleinteger nullable

Id agent module

idAlertAminteger nullable

Id alert action

severityinteger

Event severity, the available severity are: maintenance, informational, normal, warning, critical, minor, major

tagsstring nullable

Tags

sourcestring nullable

Source

idExtrastring nullable

Extra id

criticalInstructionsstring nullable

Critical instructions

warningInstructionsstring nullable

Warning instructions

unknownInstructionsstring nullable

Unknows instructions

ownerUserstring nullable

Id user

ackUtimestampinteger nullable

Event ack utimestamp

customDatastring nullable

Custom data

datastring nullable

Data

moduleStatusinteger nullable

Module status

eventCustomIdstring nullable

Events Custom Id

Example response

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

Changes

  • v2e09afeb73c0cRevision changes
    • breaking

      added the new path request parameter idEvent

    • breaking

      request body became required

    • info

      added the media type application/json to the request body

    • info

      added the media type application/json for the response with the status

  • v2d42e8bf36592Revision changes
    • breaking

      removed the media type application/json from the request body

    • breaking

      removed the media type application/json for the response with the status

    • warning

      deleted the path request parameter idEvent

    • info

      request body became optional