Query Alerts
Query HCX alerts with filters
Queries and retrieves HCX system alerts based on flexible filter criteria including severity, state, time range, entity, module, and category. This API provides comprehensive access to all system alerts generated by HCX components including appliances, migrations, network extensions, service mesh operations, and system health events. Alerts represent important events, warnings, errors, and informational messages that require administrator attention or provide operational visibility.
Request
URI
POST
https://{server}/hybridity/api/alerts
COPY
Query Parameters
string
action
Required
Action to perform on the alerts endpoint. Must be set to 'query' to retrieve alerts. This parameter distinguishes the query operation from other potential alert operations on the same endpoint.
Request Body
nls_1.0_query_alerts_request
of type(s)
application/json
Optional
"nls_1.0_query_alerts_request Object"Authentication
This operation uses the following authentication methods.
Responses
200
Accepted
Returns
nls_1.0_query_alerts_response
of type(s)
application/json
"nls_1.0_query_alerts_response Object"
401
Unauthorized
Operation doesn't return any data structure
403
Forbidden
Operation doesn't return any data structure
Code Samples
COPY
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '[{}]' https://{api_host}/hybridity/api/alerts
On This Page
Hcx Alerts Apis Operations
POST
Query Alerts
POST
Acknowledge Hcx Alert
DELETE
Delete Hcx Alert