Update Symptom Definition Using PUT

Update Symptom Definition Using PUT

Update an existing Symptom Definition

Request
URI
PUT
https://{api_host}/api/symptomdefinitions
COPY
Request Body

The Symptom Definition to update

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

Show optional properties

{
    "adapterKindKey": "string",
    "resourceKindKey": "string"
}
{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "id": "string",
    "name": "string",
    "realtimeMonitoringEnabled": false,
    "resourceKindKey": "string",
    "state": {
        "condition": {
            "instanced": false,
            "key": "string",
            "operator": "string",
            "settingValue": "string",
            "targetKey": "string",
            "thresholdType": "string"
        },
        "severity": "string"
    },
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind identifier for the SymptomDefinition

integer As int32 As int32
cancelCycles
Optional

The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled

string
id
Optional

The identifier for the SymptomDefinition. Must be null during create.

string
name
Optional

The name of the SymptomDefinition

boolean
realtimeMonitoringEnabled
Optional

Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)

string
resourceKindKey
Required

The resource kind identifier for the SymptomDefinition

symptom-state
state
Optional

The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.

integer As int32 As int32
waitCycles
Optional

The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered

Authentication
This operation uses the following authentication methods.
Responses
200

The updated Symptom Definition

Returns symptom-definition of type(s) application/json 
{
    "adapterKindKey": "string",
    "cancelCycles": 0,
    "id": "string",
    "name": "string",
    "realtimeMonitoringEnabled": false,
    "resourceKindKey": "string",
    "state": {
        "condition": {
            "instanced": false,
            "key": "string",
            "operator": "string",
            "settingValue": "string",
            "targetKey": "string",
            "thresholdType": "string"
        },
        "severity": "string"
    },
    "waitCycles": 0
}
string
adapterKindKey
Required

The adapter kind identifier for the SymptomDefinition

integer As int32 As int32
cancelCycles
Optional

The number of consecutive cycles to wait when a symptom state is false before a symptom is cancelled

string
id
Optional

The identifier for the SymptomDefinition. Must be null during create.

string
name
Optional

The name of the SymptomDefinition

boolean
realtimeMonitoringEnabled
Optional

Indicates whether real-time monitoring is enabled for the symptom or not. (This field is only visible in SaaS)

string
resourceKindKey
Required

The resource kind identifier for the SymptomDefinition

symptom-state
state
Optional

The SymptomState is a product of the severity and a condition. A symptom definition may have one SymptomState per severity level.

integer As int32 As int32
waitCycles
Optional

The number of consecutive cycles to wait when a symptom state is true before a symptom is triggered


On This Page
Symptoms Operations
POST
Create Symptom Definition Using POST
DELETE
Delete Symptom Definition Using DELETE
GET
Get Symptom Definition By Key Using GET
GET
Get Symptom Definitions Using GET
GET
Get Symptoms Using GET
POST
Query Symptoms Using POST
PUT
Update Symptom Definition Using PUT