Update Event Details (v2.3)
PUThttps://api.us.cloudgenix.com/v2.3/api/tenants/:tenant_id/events/:event_id
Update event details.
Request
Path Parameters
The tenant ID.
The event ID.
- application/json
Body
If event is acknowledged. Value = True/False.
If acknowledged event information.
If the event is cleared. Value = True/False.
The event code.
The event correlation ID.
The element ID.
The event reference.
info object
The event notes.
policy_info object
The event priority.
The event severity level.
The site ID.
If the event is suppressed. Value = True/False.
suppressed_info object
The time and date when the event occurred.
The event type.
Responses
- 200
- 400
Successful Operation
- application/json
- Schema
- Example (auto)
Schema
If event is acknowledged. Value = True/False.
If acknowledged event information.
If the event is cleared. Value = True/False.
The event code.
The event correlation ID.
The element ID.
The event reference.
info object
The event notes.
policy_info object
The event priority.
The event severity level.
The site ID.
If the event is suppressed. Value = True/False.
suppressed_info object
The time and date when the event occurred.
The event type.
{
"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"
}
Bad Request
- application/json
- Schema
- Example (auto)
- Example
Schema
_error ErrorResponse[]
{
"_error": [
{
"code": "string",
"message": "string"
}
]
}
{
"value": {
"_error": [
{
"code": "INVALID_REQUEST_ERROR_0001"
}
]
}
}
- curl
- python
- go
- nodejs
- csharp
- php
- CURL
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"
}'