Disable Search Based Alert Config

Disable an existing Search Based Alert Configuration (User Defined Alert Configuration).

Request

URI

POST

https://{api_host}/api/ni/settings/alerts/search-based-alerts/{id}/disable

COPY

Path Parameters

string

Required

The Entity ID of object requestion information on

Authentication

This operation uses the following authentication methods.

ApiKeyAuth

Responses

200

Success

Returns SearchBasedAlertConfigResponse of type(s) application/json

{
    "entity_id": "string",
    "alert_name": "string",
    "enabled": false,
    "search_criteria": "string",
    "generate_alert_criteria": "string",
    "alert_type": "string",
    "severity": "string",
    "notification_settings": [
        {
            "type": "string",
            "frequency": "string",
            "notification_time": "string",
            "receivers": [
                "string"
            ],
            "enabled": false
        }
    ]
}

string

entity_id

Optional

entity_id

string

alert_name

Optional

Name of the Search based Alert Configuration.

boolean

enabled

Optional

Boolean value to depict if the Search based alert configuration is enabled.

string

search_criteria

Optional

The search query for the search-based alert configuration.

GenerateEventCritera

generate_alert_criteria

Optional

The basis of raising of alerts. It can take a value SEARCH_RESULT_CHANGE or ZERO_SEARCH_RESULTS

Possible values are : SEARCH_RESULT_CHANGE, ZERO_SEARCH_RESULTS,

AlertType

alert_type

Optional

The type of alert. It can take a value PROBLEM or CHANGE.

Possible values are : PROBLEM, CHANGE, INTENT,

Severity

severity

Optional

severity

Possible values are : Critical, Moderate, Warning, Info,

array of NotificationSetting

notification_settings

Optional

Notifications configured for alerts corresponding to this alert configuration.

400

Bad Request

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

401

Unauthorized

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

403

Forbidden

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details

404

Not Found

Returns ApiError of type(s) application/json

{
    "code": 0,
    "message": "string",
    "details": [
        {
            "code": 0,
            "message": "string",
            "target": [
                "string"
            ]
        }
    ]
}

integer As int32 As int32

code

Optional

code

string

message

Optional

message

array of ErrorDetail

details

Optional

details