Create Alert Definition

Create Alert Definition
Create an Alert Definition

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}/suite-api/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": [
        {
            "base-symptom-set": {},
            "impact": {
                "detail": "string",
                "impactType": "string"
            },
            "severity": "string"
        }
    ]
}
"{\n  \"name\" : \"High CPU/Memory Usage\",\n  \"description\" : \"CPU or MEM usage too High\",\n  \"adapterKindKey\" : \"VMWARE\",\n  \"resourceKindKey\" : \"HostSystem\",\n  \"waitCycles\" : 3,\n  \"cancelCycles\" : 2,\n  \"type\" : 0,\n  \"subType\" : 0,\n  \"states\" : [ {\n    \"severity\" : \"WARNING\",\n    \"base-symptom-set\" : {\n      \"type\" : \"SYMPTOM_SET_COMPOSITE\",\n      \"operator\" : \"AND\",\n      \"symptom-sets\" : [ {\n        \"type\" : \"SYMPTOM_SET\",\n        \"adapterKindKey\" : \"VMWARE\",\n        \"resourceKindKey\" : \"Datastore\",\n        \"relation\" : \"DESCENDANT\",\n        \"aggregation\" : \"ALL\",\n        \"symptomSetOperator\" : \"AND\",\n        \"symptomDefinitionIds\" : [ \"Symptom5\", \"!Symptom6\" ],\n        \"alertConditions\" : [ {\n          \"waitCycles\" : 5,\n          \"cancelCycles\" : 5,\n          \"severity\" : \"CRITICAL\",\n          \"condition\" : {\n            \"type\" : \"CONDITION_HT\",\n            \"key\" : \"cpu|demandmhz\",\n            \"operator\" : \"GT_EQ\",\n            \"valueType\" : \"NUMERIC\",\n            \"instanced\" : false,\n            \"targetKey\" : \"cpu|availablemhz\",\n            \"thresholdType\" : \"STATKEY\"\n          }\n        } ]\n      }, {\n        \"type\" : \"SYMPTOM_SET\",\n        \"relation\" : \"SELF\",\n        \"aggregation\" : \"ALL\",\n        \"symptomSetOperator\" : \"OR\",\n        \"symptomDefinitionIds\" : [ \"Symptom100\", \"Symptom101\" ]\n      } ]\n    },\n    \"impact\" : {\n      \"impactType\" : \"BADGE\",\n      \"detail\" : \"health\"\n    }\n  } ],\n  \"forVCDTenants\" : false\n}"
string
adapterKindKey
Required

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

integer As int32 As int32
cancelCycles
Optional
Constraints: minimum: 1

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

string
description
Optional

The description of the problem definition

boolean
forVCDTenants
Optional

Is alert definition for tenants or not

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 object
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
Constraints: minimum: 1

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 
"{\n  \"id\" : \"f080147f-c60d-4f08-8801-b602e2931b6f\",\n  \"name\" : \"High CPU/Memory Usage\",\n  \"description\" : \"CPU or MEM usage too High\",\n  \"adapterKindKey\" : \"VMWARE\",\n  \"resourceKindKey\" : \"HostSystem\",\n  \"waitCycles\" : 3,\n  \"cancelCycles\" : 2,\n  \"type\" : 0,\n  \"subType\" : 0,\n  \"states\" : [ {\n    \"severity\" : \"WARNING\",\n    \"base-symptom-set\" : {\n      \"type\" : \"SYMPTOM_SET_COMPOSITE\",\n      \"operator\" : \"AND\",\n      \"symptom-sets\" : [ {\n        \"type\" : \"SYMPTOM_SET\",\n        \"adapterKindKey\" : \"VMWARE\",\n        \"resourceKindKey\" : \"Datastore\",\n        \"relation\" : \"DESCENDANT\",\n        \"aggregation\" : \"ALL\",\n        \"symptomSetOperator\" : \"AND\",\n        \"symptomDefinitionIds\" : [ \"Symptom5\", \"!Symptom6\" ],\n        \"alertConditions\" : [ {\n          \"waitCycles\" : 5,\n          \"cancelCycles\" : 5,\n          \"severity\" : \"CRITICAL\",\n          \"condition\" : {\n            \"type\" : \"CONDITION_HT\",\n            \"key\" : \"cpu|demandmhz\",\n            \"operator\" : \"GT_EQ\",\n            \"valueType\" : \"NUMERIC\",\n            \"instanced\" : false,\n            \"targetKey\" : \"cpu|availablemhz\",\n            \"thresholdType\" : \"STATKEY\"\n          }\n        } ]\n      }, {\n        \"type\" : \"SYMPTOM_SET\",\n        \"relation\" : \"SELF\",\n        \"aggregation\" : \"ALL\",\n        \"symptomSetOperator\" : \"OR\",\n        \"symptomDefinitionIds\" : [ \"Symptom100\", \"Symptom101\" ]\n      } ]\n    },\n    \"impact\" : {\n      \"impactType\" : \"BADGE\",\n      \"detail\" : \"health\"\n    }\n  } ],\n  \"forVCDTenants\" : false\n}"
string
adapterKindKey
Required

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

integer As int32 As int32
cancelCycles
Optional
Constraints: minimum: 1

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

string
description
Optional

The description of the problem definition

boolean
forVCDTenants
Optional

Is alert definition for tenants or not

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 object
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
Constraints: minimum: 1

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


Code Samples
COPY
                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapterKindKey":"string","name":"string","resourceKindKey":"string","states":["object"]}' https://{api_host}/suite-api/api/alertdefinitions
On This Page
Alerts Operations
GET
Get Alert Definitions
POST
Create Alert Definition
PUT
Update Alert Definition
POST
Query Alert Definitions
DELETE
Delete Alert Definition
GET
Get Alert Definition By Id
PUT
Disable Alert Definition In Policies
PUT
Enable Alert Definition In Policies
GET
Get Alerts
POST
Modify Alerts
DELETE
Delete Canceled Alerts
GET
Get Alert Contributing Symptoms
POST
Query Alert Groups
POST
Query Alert Notes
POST
Query Alert
GET
Get Alert Types
GET
Get Alert
GET
Get Alert Notes
POST
Add Alert Note
DELETE
Delete Alert Note
GET
Get Alert Note