Event API endpoints
Events provide a way to track configuration changes, incidents, application crashes, or infrastructure upgrades. You can link events to specific entities and track their history. Displaying events on analysis charts can help you better understand factors, such as the performance impact of a hardware upgrade. For details on events, see Working with events.
Use the Event API endpoints to retrieve event details according to your authorization profile. Before you run an endpoint, make sure that you authenticate the API request.
openapi: 3.0.1
paths:
/opt/api/v1/events/trend:
post:
tags:
- events-integration-controller
description: |-
Returns trend data for events
List of request attributes
- entity_ids: Search events by the associated entity ID.
- domain_ids: Search for events associated with provided domains; if no domains are provided, return events from all authorized domains.
- include_subdomains: If true, search for events that are associated with the provided domains and their sub-domains. If false, search only for events that are directly associated with provided domains.
The following fields can be used in conditional filters:
- creation_time: Search for events based on their creation time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- resolution_time: Search for events based on their resolution time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- identifier: The unique ID of the event.
Supported operator: IN
- source_class: Filter events by their source type class (e.g., 'HOST_STATUS').
Supported operator: IN
- event_type: Filter events by their type (e.g., 'NOT_PLANNED.INCIDENT').
Supported operator: IN
- message: Search for events by their name.
Supported operators: IN, LIKE
- details: Search for events by their description.
Supported operators: IN, LIKE
- severity: Filter events by their severity level.
Supported operator: IN
- status: Filter events by their current status, which can be one of the following: 'OPEN', 'ACK', 'ASSIGNED', 'CLOSED', or 'BLACKOUT'.
Supported operator: IN
operationId: trend
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventTrendRequest'
required: true
responses:
'200':
description: OK
content:
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/EventTrend'
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- >-
org.springframework.web.bind.MissingServletRequestParameterException
- >-
org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- org.springframework.web.bind.MethodArgumentNotValidException
- java.lang.IllegalArgumentException
- java.lang.IllegalStateException
- org.springframework.http.converter.HttpMessageNotReadableException
- jakarta.validation.ConstraintViolationException
'401':
description: Unauthorized
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.ade.auth.client.exception.UnauthorizedException
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.dataprv.common.exception.ResourceNotFoundException
- org.springframework.web.servlet.NoHandlerFoundException
'405':
description: Method Not Allowed
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- org.springframework.web.HttpRequestMethodNotSupportedException
'500':
description: Internal Server Error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- java.lang.Exception
/opt/api/v1/events/summary:
post:
tags:
- events-integration-controller
description: |-
Returns summary data for events
List of request attributes
- entity_ids: Search events by the associated entity ID.
- domain_ids: Search for events that associated with provided domains, if no domains provided then returns events from all authorized domains.
- include_subdomains: If true, search for events that are associated with the provided domains and their sub-domains. If false, search only for events that are directly associated with provided domains.
The following fields can be used in conditional filters:
- creation_time: Search for events based on their creation time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- resolution_time: Search for events based on their resolution time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- identifier: The unique ID of the event.
Supported operator: IN
- source_class: Filter events by their source type class (e.g., 'HOST_STATUS').
Supported operator: IN
- event_type: Filter events by their type (e.g., 'NOT_PLANNED.INCIDENT').
Supported operator: IN
- message: Search for events by their name.
Supported operators: IN, LIKE
- details: Search for events by their description.
Supported operators: IN, LIKE
- severity: Filter events by their severity level.
Supported operator: IN
- status: Filter events by their current status, which can be one of the following: 'OPEN', 'ACK', 'ASSIGNED', 'CLOSED', or 'BLACKOUT'.
Supported operator: IN
operationId: summary
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventSummaryRequest'
required: true
responses:
'200':
description: OK
content:
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/EventSummary'
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- >-
org.springframework.web.bind.MissingServletRequestParameterException
- >-
org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- org.springframework.web.bind.MethodArgumentNotValidException
- java.lang.IllegalArgumentException
- java.lang.IllegalStateException
- org.springframework.http.converter.HttpMessageNotReadableException
- jakarta.validation.ConstraintViolationException
'401':
description: Unauthorized
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.ade.auth.client.exception.UnauthorizedException
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.dataprv.common.exception.ResourceNotFoundException
- org.springframework.web.servlet.NoHandlerFoundException
'405':
description: Method Not Allowed
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- org.springframework.web.HttpRequestMethodNotSupportedException
'500':
description: Internal Server Error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- java.lang.Exception
/opt/api/v1/events/search:
post:
tags:
- events-integration-controller
description: >-
Search for events with advanced filtering options. Results are sorted by
creation_date in DESC order
List of request attributes
- entity_ids: Search events by the associated entity ID.
- domain_ids: Search for events that associated with provided domains, if no domains provided then returns events from all authorized domains.
- include_subdomains: If true, search for events that are associated with the provided domains and their sub-domains. If false, search only for events that are directly associated with provided domains.
The following fields can be used in conditional filters:
- creation_time: Search for events based on their creation time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- resolution_time: Search for events based on their resolution time. Values as ISO date format: e.g. '2025-01-01T00:15:00Z' or in milliseconds.
Supported operator: GREATER_THAN, LOWER_THAN
- identifier: The unique ID of the event.
Supported operator: IN
- source_class: Filter events by their source type class (e.g., 'HOST_STATUS').
Supported operator: IN
- event_type: Filter events by their type (e.g., 'NOT_PLANNED.INCIDENT').
Supported operator: IN
- message: Search for events by their name.
Supported operators: IN, LIKE
- details: Search for events by their description.
Supported operators: IN, LIKE
- severity: Filter events by their severity level.
Supported operator: IN
- status: Filter events by their current status, which can be one of the following: 'OPEN', 'ACK', 'ASSIGNED', 'CLOSED', or 'BLACKOUT'.
Supported operator: IN
operationId: search
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/EventSearchRequest'
required: true
responses:
'200':
description: OK
content:
application/hal+json:
schema:
type: array
items:
$ref: '#/components/schemas/DetailedEvent'
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- >-
org.springframework.web.bind.MissingServletRequestParameterException
- >-
org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- org.springframework.web.bind.MethodArgumentNotValidException
- java.lang.IllegalArgumentException
- java.lang.IllegalStateException
- org.springframework.http.converter.HttpMessageNotReadableException
- jakarta.validation.ConstraintViolationException
'401':
description: Unauthorized
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.ade.auth.client.exception.UnauthorizedException
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.dataprv.common.exception.ResourceNotFoundException
- org.springframework.web.servlet.NoHandlerFoundException
'405':
description: Method Not Allowed
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- org.springframework.web.HttpRequestMethodNotSupportedException
'500':
description: Internal Server Error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- java.lang.Exception
'/opt/api/v1/events/{eventId}':
get:
tags:
- events-integration-controller
description: Retrieve event details by event identifier
operationId: getEvent
parameters:
- name: eventId
in: path
description: Event identifier
required: true
schema:
type: string
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/DetailedEvent'
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- >-
org.springframework.web.bind.MissingServletRequestParameterException
- >-
org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- org.springframework.web.bind.MethodArgumentNotValidException
- java.lang.IllegalArgumentException
- java.lang.IllegalStateException
- org.springframework.http.converter.HttpMessageNotReadableException
- jakarta.validation.ConstraintViolationException
'401':
description: Unauthorized
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.ade.auth.client.exception.UnauthorizedException
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.dataprv.common.exception.ResourceNotFoundException
- org.springframework.web.servlet.NoHandlerFoundException
'405':
description: Method Not Allowed
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- org.springframework.web.HttpRequestMethodNotSupportedException
'500':
description: Internal Server Error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- java.lang.Exception
/opt/api/v1/events/about:
get:
tags:
- events-integration-controller
description: Retrieve information about event endpoint service
operationId: about
responses:
'200':
description: OK
content:
application/hal+json:
schema:
$ref: '#/components/schemas/About'
'400':
description: Bad Request
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- >-
org.springframework.web.bind.MissingServletRequestParameterException
- >-
org.springframework.web.method.annotation.MethodArgumentTypeMismatchException
- org.springframework.web.bind.MethodArgumentNotValidException
- java.lang.IllegalArgumentException
- java.lang.IllegalStateException
- org.springframework.http.converter.HttpMessageNotReadableException
- jakarta.validation.ConstraintViolationException
'401':
description: Unauthorized
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.ade.auth.client.exception.UnauthorizedException
'404':
description: Not Found
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- com.bmc.bco.dataprv.common.exception.ResourceNotFoundException
- org.springframework.web.servlet.NoHandlerFoundException
'405':
description: Method Not Allowed
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- org.springframework.web.HttpRequestMethodNotSupportedException
'500':
description: Internal Server Error
content:
application/hal+json:
schema:
$ref: '#/components/schemas/ApiError'
x-exception-class:
- java.lang.Exception
components:
schemas:
ApiError:
required:
- errorCode
- message
- status
type: object
properties:
status:
type: string
description: The status of error response
enum:
- ERROR
- WARNING
errorCode:
type: string
description: The code of error response
message:
type: string
description: The message of error response
errorDetails:
$ref: '#/components/schemas/ErrorDetails'
description: Default error response for API
ErrorDetails:
type: object
properties:
datamart_name:
type: string
description: Name of the datamart
datamart_id:
type: integer
description: Id of the datamart
format: int64
description: Api error details
EventTrendRequest:
type: object
properties:
entity_ids:
type: array
description: IDs of entities
items:
type: string
description: IDs of entities
domain_ids:
type: array
description: List of domain IDs
items:
type: string
description: List of domain IDs
resolution:
pattern: ^(DAILY|WEEKLY|MONTHLY)$
type: string
description: Trend resolution
default: MONTHLY
include_subdomains:
type: boolean
description: Include subdomains
default: true
conditions:
type: array
description: List of search conditions
items:
$ref: '#/components/schemas/SearchCondition'
description: Represents event trend request
SearchCondition:
required:
- filters
type: object
properties:
filters:
type: array
items:
$ref: '#/components/schemas/SearchFilter'
description: List of search conditions
SearchFilter:
required:
- field_name
- operator
- values
type: object
properties:
field_name:
type: string
operator:
type: string
values:
type: array
items:
type: string
EventSeverityData:
type: object
properties:
severity_stats:
type: object
additionalProperties:
type: integer
description: Mapping of event severities to their count
format: int64
description: Mapping of event severities to their count
example:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total:
type: integer
description: Total number of events
format: int64
example: 100
description: Represents severity data about events
example:
NOT_PLANNED.INCIDENT:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
FORECASTED_SATURATION:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
EventTrend:
type: object
properties:
timestamp:
type: integer
format: int64
event_data:
type: object
additionalProperties:
$ref: '#/components/schemas/EventSeverityData'
description: Mapping of event types to their severity statistics
example:
NOT_PLANNED.INCIDENT:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
FORECASTED_SATURATION:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
description: Represents trend data of events.
EventSummaryRequest:
type: object
properties:
domain_ids:
type: array
description: IDs of domains
items:
type: string
description: IDs of domains
entity_ids:
type: array
description: IDs of entities
items:
type: string
description: IDs of entities
include_subdomains:
type: boolean
description: Include subdomains
default: true
conditions:
type: array
description: List of search conditions
items:
$ref: '#/components/schemas/SearchCondition'
description: Represents event summary request
EventSummary:
type: object
properties:
app_id:
type: number
app_name:
type: string
description: Domain name
example: Public API Web Services
event_data:
type: object
additionalProperties:
$ref: '#/components/schemas/EventSeverityData'
description: Mapping of event types to their severity statistics
example:
NOT_PLANNED.INCIDENT:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
FORECASTED_SATURATION:
severity_stats:
UNKNOWN: 0
OK: 10
INFO: 20
WARNING: 30
MINOR: 40
MAJOR: 50
CRITICAL: 0
total: 100
description: Represents summary details of events.
EventSearchRequest:
type: object
properties:
domain_ids:
type: array
description: IDs of domains
items:
type: string
description: IDs of domains
entity_ids:
type: array
description: IDs of entities
items:
type: string
description: IDs of entities
include_subdomains:
type: boolean
description: Include subdomains
default: true
conditions:
type: array
description: List of search conditions
items:
$ref: '#/components/schemas/SearchCondition'
description: Represents event search request
DetailedEvent:
required:
- event_type
- message
type: object
properties:
source_event_id:
type: string
creation_time:
type: string
format: date-time
intervent_time:
type: string
format: date-time
resolution_time:
type: string
format: date-time
message:
maxLength: 2147483647
minLength: 1
type: string
details:
type: string
note:
type: string
event_type:
pattern: >-
^(NOT_PLANNED.INCIDENT|PLANNED.GENERIC|PLANNED.MAINTENANCE|PLANNED.CHANGE|NOT_PLANNED.PROBLEM|NOT_PLANNED.ERROR|UNKNOWN|DETECTED)$
type: string
color:
type: string
period:
type: integer
format: int64
recurrent_ev_since_time:
type: string
format: date-time
recurrent_ev_to_time:
type: string
format: date-time
severity:
type: string
enum:
- UNKNOWN
- OK
- INFO
- WARNING
- MINOR
- MAJOR
- CRITICAL
service_unavailability:
type: boolean
source_class:
type: string
occurrences:
type: integer
format: int32
srcid:
type: integer
format: int32
pending_time:
type: string
format: date-time
state_transition_time:
type: string
format: date-time
entity_id:
type: number
identifier:
type: string
class:
type: string
source_identifier:
type: string
tracing_type:
type: string
enum:
- STATELESS
- STATESUMMARY
- STATETRANSITION
arrival_time:
type: string
format: date-time
predicted_saturation_date:
type: string
format: date-time
incident_id:
type: string
status:
type: string
saturated_resources:
type: string
saturated_subresources:
type: string
entity_name:
type: string
description: Entity name
entity_type_name:
type: string
description: Entity type
example: Generic
app_id:
type: number
description: Domain ID
app_name:
type: string
description: Domain name
app_type_name:
type: string
entity_tags:
type: string
description: Represents detailed information about an event.
About:
type: object
properties:
product:
type: string
component:
type: string
api_versions:
type: array
items:
type: string