Query Events for Pagination Support (v3.5)

POST 
/v3.5/api/tenants/:tenant_id/events/query

Query events for supporting pagination.

Request

Path Parameters

tenant_id stringrequired

The tenant ID.

application/json

Body

_offset date-time

Event offset time and date information.

acknowledged boolean

If event is acknowledged. Value = True/False.

end_time date-time

The event end time.

limit object

count integer

sort_on string

sort_order string

Possible values: [ascending, descending]

priority string[]

Possible values: [p1, p2, p3, p4]

The event priority.

query object
The query details of event category, code, correlation ID, entitity reference, site, and type.
category string[]
code string[]
correlation_id string[]
entity_ref string[]
site string[]
type string[]
severity string[]

Possible values: [critical, major, minor]

The event severity level.

start_time date-time

The event start time.

suppressed boolean

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[]
time_type string

Possible values: [raised, created]

The event time type.

view object
The event viewing details.
individual string
Possible values: [site, code, category, entity, correlation, tenant]
summary boolean

Responses

200

Successful Operation

application/json

Schema

Schema

_request_id string

The event query request ID.

_status_code integer

The status code of the event.

included_count integer
items object[]
The details of the event query.
Array [
_created_on_utc date-time
_etag string
_updated_on_utc date-time
acknowledged boolean
acknowledgement_info object
acknowledged_by string
acknowledgement_time date-time
cleared boolean
code string
correlation_id string
entity_ref string
id string
ident string
info object
policy_info object
policyrule_id string
policyset_id string
priority string
severity string
standing boolean
suppressed boolean
suppressed_info object
event_id string
other_reason string
suppressed_time date-time
time date-time
type string
]
total_count integer

The event query total count.

Example (from schema)

{
  "_request_id": "string",
  "_status_code": 0,
  "included_count": 0,
  "items": [
    {
      "_created_on_utc": "2024-07-29T15:51:28.071Z",
      "_etag": "string",
      "_updated_on_utc": "2024-07-29T15:51:28.071Z",
      "acknowledged": true,
      "acknowledgement_info": {
        "acknowledged_by": "string",
        "acknowledgement_time": "2024-07-29T15:51:28.071Z"
      },
      "cleared": true,
      "code": "string",
      "correlation_id": "string",
      "entity_ref": "string",
      "id": "string",
      "ident": "string",
      "info": {},
      "policy_info": {
        "policyrule_id": "string",
        "policyset_id": "string"
      },
      "priority": "string",
      "severity": "string",
      "standing": true,
      "suppressed": true,
      "suppressed_info": {
        "event_id": "string",
        "other_reason": "string",
        "suppressed_time": "2024-07-29T15:51:28.071Z"
      },
      "time": "2024-07-29T15:51:28.071Z",
      "type": "string"
    }
  ],
  "total_count": 0
}

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...