Skip to main content

Update Event Details (v2.3)

PUT 

https://api.us.cloudgenix.com/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.

Body

    acknowledgedboolean

    If event is acknowledged. Value = True/False.

    acknowledgement_infostring

    If acknowledged event information.

    clearedboolean

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

    codestring

    The event code.

    correlation_idstring

    The event correlation ID.

    element_idstring

    The element ID.

    entity_refstring

    The event reference.

    idstring
    info object

    The details of the hub cluster ID.

    hub_cluster_idstring
    notesstring

    The event notes.

    policy_info object

    The event policy information; time the policy was applied, policy rule ID, and policy set ID.

    policy_applied_timestring
    policyrule_idstring
    policyset_idstring
    prioritystring

    The event priority.

    severitystring

    The event severity level.

    site_idstring

    The site ID.

    suppressedstring

    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_idsstring
    other_reasonsstring
    summary_event_idsstring
    suppressed_timestring
    timestring

    The time and date when the event occurred.

    typestring

    The event type.

Responses

Successful Operation

Schema
    acknowledgedboolean

    If event is acknowledged. Value = True/False.

    acknowledgement_infostring

    If acknowledged event information.

    clearedboolean

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

    codestring

    The event code.

    correlation_idstring

    The event correlation ID.

    element_idstring

    The element ID.

    entity_refstring

    The event reference.

    idstring
    info object

    The details of the hub cluster ID.

    hub_cluster_idstring
    notesstring

    The event notes.

    policy_info object

    The event policy information; time the policy was applied, policy rule ID, and policy set ID.

    policy_applied_timestring
    policyrule_idstring
    policyset_idstring
    prioritystring

    The event priority.

    severitystring

    The event severity level.

    site_idstring

    The site ID.

    suppressedstring

    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_idsstring
    other_reasonsstring
    summary_event_idsstring
    suppressed_timestring
    timestring

    The time and date when the event occurred.

    typestring

    The event type.

curl -L -X PUT 'https://api.us.cloudgenix.com/v2.3/api/tenants/:tenant_id/events/:event_id' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-d '{
"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"
}'
Request Collapse all
Base URL
https://api.us.cloudgenix.com
Parameters
— pathrequired
— pathrequired
Body
{
  "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"
}
ResponseClear

Click the Send API Request button above and see the response here!