Get Alert Definition By Id

Get Alert Definition By Id

Using this method, you can look up details about a particular alert definition

Request
URI
GET
https://{api_host}/suite-api/api/alertdefinitions/{id}
COPY
Path Parameters
string
id
Required

The id of the Alert Definition


Authentication
This operation uses the following authentication methods.
Responses
200

The Alert Definition corresponding to the identifier specified

Returns alert-definition of type(s) application/json
"{\n  \"id\" : \"AlertDefinition-147ff080-8801-c60d-4f08-931b6fb602e2\",\n  \"name\" : \"MyAlertDefinition\",\n  \"description\" : \"An Alert Definition associated with ESX host\",\n  \"adapterKindKey\" : \"VMWARE\",\n  \"resourceKindKey\" : \"HostSystem\",\n  \"waitCycles\" : 3,\n  \"cancelCycles\" : 2,\n  \"type\" : 0,\n  \"subType\" : 0,\n  \"states\" : [ {\n    \"severity\" : \"CRITICAL\",\n    \"base-symptom-set\" : {\n      \"type\" : \"SYMPTOM_SET\",\n      \"relation\" : \"SELF\",\n      \"aggregation\" : \"ALL\",\n      \"symptomDefinitionIds\" : [ \"SymptomDefinition-5\" ]\n    },\n    \"impact\" : {\n      \"impactType\" : \"BADGE\",\n      \"detail\" : \"Health\"\n    }\n  } ],\n  \"forVCDTenants\" : false\n}"
string
id
Optional

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

string
name
Required

The Name of the Problem Definition

string
description
Optional

The description of the problem definition

string
adapterKindKey
Required

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

string
resourceKindKey
Required

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

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

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

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

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

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
subType
Optional

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

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.

boolean
forVCDTenants
Optional

Is alert definition for tenants or not


404

No Alert Definition has been found for the identifier specified

Operation doesn't return any data structure

Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/suite-api/api/alertdefinitions/{id}