Update Event Details (v2.3)

PUT 
/v2.3/api/tenants/:tenant_id/events/:event_id

Update event details.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

event_id stringrequired

The event ID.

application/json

Body

acknowledged boolean

If event is acknowledged. Value = True/False.

acknowledgement_info string

If acknowledged event information.

cleared boolean

If the event is cleared. Value = True/False.

code string

The event code.

correlation_id string

The event correlation ID.

element_id string

The element ID.

entity_ref string

The event reference.

id string
info object
The details of the hub cluster ID.
hub_cluster_id string
notes string

The event notes.

policy_info object
The event policy information; time the policy was applied, policy rule ID, and policy set ID.
policy_applied_time string
policyrule_id string
policyset_id string
priority string

The event priority.

severity string

The event severity level.

site_id string

The site ID.

suppressed string

If the event is suppressed. Value = True/False.

suppressed_info object
Information on the suppressed event - event ID, suppressed time, summary event IDs etc.
event_ids string
other_reasons string
summary_event_ids string
suppressed_time string
time string

The time and date when the event occurred.

type string

The event type.

Responses

200

Successful Operation

application/json

Schema

Schema

acknowledged boolean

If event is acknowledged. Value = True/False.

acknowledgement_info string

If acknowledged event information.

cleared boolean

If the event is cleared. Value = True/False.

code string

The event code.

correlation_id string

The event correlation ID.

element_id string

The element ID.

entity_ref string

The event reference.

id string
info object
The details of the hub cluster ID.
hub_cluster_id string
notes string

The event notes.

policy_info object
The event policy information; time the policy was applied, policy rule ID, and policy set ID.
policy_applied_time string
policyrule_id string
policyset_id string
priority string

The event priority.

severity string

The event severity level.

site_id string

The site ID.

suppressed string

If the event is suppressed. Value = True/False.

suppressed_info object
Information on the suppressed event - event ID, suppressed time, summary event IDs etc.
event_ids string
other_reasons string
summary_event_ids string
suppressed_time string
time string

The time and date when the event occurred.

type string

The event type.

Example (from schema)

{
  "acknowledged": true,
  "acknowledgement_info": "string",
  "cleared": true,
  "code": "string",
  "correlation_id": "string",
  "element_id": "string",
  "entity_ref": "string",
  "id": "string",
  "info": {
    "hub_cluster_id": "string"
  },
  "notes": "string",
  "policy_info": {
    "policy_applied_time": "string",
    "policyrule_id": "string",
    "policyset_id": "string"
  },
  "priority": "string",
  "severity": "string",
  "site_id": "string",
  "suppressed": "string",
  "suppressed_info": {
    "event_ids": "string",
    "other_reasons": "string",
    "summary_event_ids": "string",
    "suppressed_time": "string"
  },
  "time": "string",
  "type": "string"
}

400

Bad Request

application/json

Schema

Schema

_error ErrorResponse[]
Array [
code string
The error code.
message string
The error message.
]

Example (from schema)

{
  "_error": [
    {
      "code": "string",
      "message": "string"
    }
  ]
}

Example

{
  "value": {
    "_error": [
      {
        "code": "INVALID_REQUEST_ERROR_0001"
      }
    ]
  }
}

Loading...