Create Symptom Definition

The symptom definition identifier must be null and will be generated by the system.
A symptom definition contains a symptom state, there may only be one symptom state per symptom definition.

Request

URI

POST

https://{api_host}/suite-api/api/symptomdefinitions

COPY

Request Body

The Symptom Definition to create

symptom-definition of type(s) application/json

Required

Show optional properties

{
    "name": "string",
    "adapterKindKey": "string",
    "resourceKindKey": "string",
    "state": {
        "severity": "string",
        "condition": {}
    }
}

{
    "id": "string",
    "name": "string",
    "adapterKindKey": "string",
    "resourceKindKey": "string",
    "waitCycles": 0,
    "cancelCycles": 0,
    "realtimeMonitoringEnabled": false,
    "state": {
        "severity": "string",
        "condition": {}
    }
}

string

Optional

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

string

name

Required

The name of the SymptomDefinition

string

adapterKindKey

Required

The adapter kind identifier for the SymptomDefinition

string

resourceKindKey

Required

The resource kind identifier for the SymptomDefinition

integer As int32 As int32

waitCycles

Optional

Constraints: minimum: 1

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

integer As int32 As int32

cancelCycles

Optional

Constraints: minimum: 1

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

boolean

realtimeMonitoringEnabled

Optional

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

object

state

Required

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

Authentication

This operation uses the following authentication methods.

Token-based-authorization

Responses

201

The created Symptom Definition

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

"symptom-definition Object"

string

Optional

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

string

name

Required

The name of the SymptomDefinition

string

adapterKindKey

Required

The adapter kind identifier for the SymptomDefinition

string

resourceKindKey

Required

The resource kind identifier for the SymptomDefinition

integer As int32 As int32

waitCycles

Optional

Constraints: minimum: 1

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

integer As int32 As int32

cancelCycles

Optional

Constraints: minimum: 1

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

boolean

realtimeMonitoringEnabled

Optional

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

object

state

Required

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

Code Samples

COPY

                    curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"adapterKindKey:"string","name:"string","resourceKindKey:"string","state:"object"}' https://{api_host}/suite-api/api/symptomdefinitions

On This Page

Description

Request

Request Body

Authentication

Response

201 Response Body

Symptoms Operations

GET

Get Symptom Definitions

PUT

Update Symptom Definition