Request URL
https://<tenant-base-url>/aiops-config/api/v1.0/situation_configurations/search
Example request URL with optional parameters
POST https://<tenant-base-url>/aiops-config/api/v1.0/situation_configurations/search
Request Header
Content-Type: application/json
Authorization: Bearer <JWT_token>
For instructions on obtaining the JWT token, see Access and authentication for the REST API.
You can use the following parameters to control the request and response of the API. These parameters are grouped into top-level request body parameters, configuration object parameters, and query parameters.
Top-level request body parameters
| | | | | |
|---|
| | | Unique name of the situation configuration. This name helps identify the configuration across tenants. | | |
| | | Determines whether the situation configuration is active.
true: The configuration is enabled and applied.
false: The configuration is disabled. | | |
| | | Short description of the situation configuration, explaining its purpose or usage. | | ml_situation_config_description |
| | | Unique identifier of the situation configuration. Used to search for or update a specific configuration. | | |
| | | ID of the user who created the situation configuration. It can be used as a filter in search operations. | | |
| | | Contains advanced settings that define how situations are detected, merged, and correlated. | | See Configuration object parameters table. |
| | | | | |
|---|
| | | Time window (in minutes) during which related events are merged into a single situation. | | |
| | | Time window (in minutes) used to correlate related events into a situation. | | |
| | | Comma-separated list of identifiers for Border Gateway Protocol (BGP) related events to use in correlation. | | |
| | | Specifies whether to include or exclude incidents in situation detection. Supported values: include, exclude. | | |
incident_service_key_list | | | Comma-separated list of service keys to filter incidents associated with situations. | | l72W0nXzF6ZFWcjiCK8g_cVZLxOauaUG,
l72W0nXzF6ZFWcjiCK8g_cVZLxOauaU1 |
| incident_create_delay_in_minutes | String | No | Delay (in minutes) before creating an incident from a situation. | Request body | |
| situation-severity | String | No | Specifies the default severity level assigned to situations detected by this configuration. highest-severity: The situation’s severity is set to the highest severity of any event within that situation. root-cause-severity: The situation’s severity is set based on the severity of the root cause event. Important: After a situation is formed, any modification in severity at the event level will not be enriched automatically to the situation. | Request body | root-cause-severity, highest-severity |
| | | Type of topology links to exclude from correlation. | | |
| | | Type of topology nodes to exclude from correlation. | | |
topology_include_location | | | Determines whether location data is considered in situation correlation. | | |
topology_include_location_focus | | | Defines the topology focus areas (such as infrastructure, software, or location) to include in correlation. | | infrastructure,software-connected,location:out |
topology_exclude_reverse_link_kind | | | Specifies the types of reverse link to exclude from topology-based correlation. | | Management |
topology_include_reverse_node_kind | | | Specifies the types of reverse node types to include in topology-based correlation. | | |
offline_fingerprint_interval | | | Time interval (in minutes) used for creating fingerprints when the system is offline. | | |
fingerprint_idle_interval_for_expiry | | | Time interval (in seconds) after which idle fingerprints expire. | | |
show_policy_based_situations | | | Determines whether policy-based situations are displayed on the Situations page.
true: Policy-based situations are shown.
false: Policy-based situations are hidden. | | |
show_indirect_impact_services | | | Determines whether services that are indirectly impacted by a situation are displayed.
true (default): Indirectly impacted services are shown.
false: Indirectly impacted services are hidden. | | |
situation_confirmed_time_range_hrs | | | Time range (in hours) for confirming situations. | | |
master_situation_supported_kind | | | List of CI types supported for creating master situations. | | NetworkInterface,Database,Host |
(Optional) Query parameters for pagination and sorting
| Parameter | Value type | Mandatory | Description | Located in | Example |
|---|
| | | Maximum number of situation configurations to return in the response. | | |
| | | Starting position for retrieving records (used for pagination). | | |
| | | Field used to sort the results. Supported values: name, createdTime, modifiedTime. | | |
| | | Sort order for the results. Supported values: asc, desc. | | |
Request body
{
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {}
}
}
}
}
}
Example request body
POST request with empty body
Sample response
{
"statusMsg": "Situation configuration list retrieved successfully.",
"totalRecords": 1,
"situations": [
{
"tenantId": "123456789",
"id": "123xxxxx-4567-8911-a123b-1a23b4c5d6e7",
"name": "samplename",
"description": "123456789ababababcdcdadadadadad123412345678",
"configuration": {
'merge_window': '30',
'correlation_window': '30',
'offline_fingerprint_interval': '1440',
'show_policy_based_situations': 'true',
'topology_include_reverse_node_kind': '',
'fingerprint_idle_interval_for_expiry': '43200',
"incident_service_key_list": "12345abcVFk8LG7Gz_rI2XA_12345678"
},
"enable": true,
"createdTime": 1740396669407,
"modifiedTime": 1758168422782,
"createdBy": "558240917570502"
}
]
}
Unsuccessful responses
Unauthorized (invalid or missing token)
{
"timestamp": "2025-08-18T08:00:36.352+00:00",
"status": 401,
"error": "Unauthorized",
"path": "/aiops-config/api/v1.0/situation_configurations/search"
}
