Create Alert Definition Using POST

Create Alert Definition Using POST

Once the Alert Definition is created, a unique identifier will be generated by the system for the Alert Definition

Request
URI
POST
https://{api_host}/api/alertdefinitions
COPY
Request Body

The Alert Definition that needs to be created

alert-definition of type(s) application/json
Required

Show optional properties

{
    "adapterKindKey": "string",
    "name": "string",
    "resourceKindKey": "string",
    "states": [
        {
            "impact": {
                "detail": "string",
                "impactType": "string"
            },
            "symptoms": {}
        }
    ]
}
{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "description": "string",
    "id": "string",
    "name": "string",
    "resourceKindKey": "string",
    "states": [
        {
            "impact": {
                "detail": "string",
                "impactType": "string"
            },
            "recommendationPriorityMap": {
                "recommendationPriorityMap": 0
            },
            "severity": "string",
            "symptoms": {}
        }
    ],
    "subType": 0,
    "type": 0,
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind key of the Adapter Kind that the Alert Definition applies to

integer As int32 As int32
cancelCycles
Optional

The Number of cycles the symptom conditions are false before ending the problem alert

string
description
Optional

The description of the problem definition

string
id
Optional

The unique identifier across the system. Must be null during create

string
name
Required

The Name of the Problem Definition

string
resourceKindKey
Required

The resource kind key for the Resource Kind that the Alert Definition applies to

array of alert-definition-state
states
Required

An Alert Definition state identifies the severity and impact a problem has when the set of Symptom Definition conditions are true. One Alert Definition state per severity.

integer As int32 As int32
subType
Optional

The sub type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32
type
Optional

The type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32
waitCycles
Optional

The Number of cycles the symptom conditions are true before triggering the problem alert

Authentication
This operation uses the following authentication methods.
Responses
201

The created Alert Definition

Returns alert-definition of type(s) application/json 
{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "description": "string",
    "id": "string",
    "name": "string",
    "resourceKindKey": "string",
    "states": [
        {
            "impact": {
                "detail": "string",
                "impactType": "string"
            },
            "recommendationPriorityMap": {
                "recommendationPriorityMap": 0
            },
            "severity": "string",
            "symptoms": {}
        }
    ],
    "subType": 0,
    "type": 0,
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind key of the Adapter Kind that the Alert Definition applies to

integer As int32 As int32
cancelCycles
Optional

The Number of cycles the symptom conditions are false before ending the problem alert

string
description
Optional

The description of the problem definition

string
id
Optional

The unique identifier across the system. Must be null during create

string
name
Required

The Name of the Problem Definition

string
resourceKindKey
Required

The resource kind key for the Resource Kind that the Alert Definition applies to

array of alert-definition-state
states
Required

An Alert Definition state identifies the severity and impact a problem has when the set of Symptom Definition conditions are true. One Alert Definition state per severity.

integer As int32 As int32
subType
Optional

The sub type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32
type
Optional

The type of the problem, for the purposes of routing an alert generated by this problem.

integer As int32 As int32
waitCycles
Optional

The Number of cycles the symptom conditions are true before triggering the problem alert


On This Page
Alerts Operations
POST
Add Alert Note Using POST
POST
Create Alert Definition Using POST
DELETE
Delete Alert Definition Using DELETE
DELETE
Delete Alert Note Using DELETE
DELETE
Delete Canceled Alerts Using DELETE
PUT
Disable Alert Definition In Policies Using PUT
PUT
Enable Alert Definition In Policies Using PUT
GET
Get Alert Contributing Symptoms Using GET
GET
Get Alert Definition By Id Using GET
GET
Get Alert Definitions Using GET
GET
Get Alert Notes Using GET
GET
Get Alert Note Using GET
GET
Get Alerts Using GET
GET
Get Alert Types Using GET
GET
Get Alert Using GET
POST
Modify Alerts Using POST
POST
Query Alert Groups Using POST
POST
Query Alert Notes Using POST
POST
Query Alert Using POST
PUT
Update Alert Definition Using PUT