AlertsΒΆ

Description

Alert APIs

DEFAULT

GET ``/api/v2/analytics/configuration/ruleassociation``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Responses

200

Type: array of TenantAlertsList

Example:

[
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "account_info": {
                "device_cluster_name": "somestring",
                "device_name": "somestring",
                "partition_name": "somestring",
                "provider_name": "somestring",
                "tenant_name": "somestring"
            },
            "action_def_id": [
                "somestring",
                "somestring"
            ],
            "action_frequency": {},
            "condition_text": "somestring",
            "filter": {
                "account_id": "somestring",
                "cluster_id": [
                    "somestring",
                    "somestring"
                ],
                "device_uuid": [
                    "somestring",
                    "somestring"
                ]
            },
            "hierarchyTree": {},
            "rule_def_id": "somestring",
            "severity": 1,
            "tags": [
                "somestring",
                "somestring"
            ]
        },
        "description": "somestring",
        "metadata": {
            "def_name": "somestring"
        },
        "name": "somestring"
    },
    {
        "account_id": "somestring",
        "created_on": "somestring",
        "def_id": "somestring",
        "def_name": "somestring",
        "definition": {
            "account_info": {
                "device_cluster_name": "somestring",
                "device_name": "somestring",
                "partition_name": "somestring",
                "provider_name": "somestring",
                "tenant_name": "somestring"
            },
            "action_def_id": [
                "somestring",
                "somestring"
            ],
            "action_frequency": {},
            "condition_text": "somestring",
            "filter": {
                "account_id": "somestring",
                "cluster_id": [
                    "somestring",
                    "somestring"
                ],
                "device_uuid": [
                    "somestring",
                    "somestring"
                ]
            },
            "hierarchyTree": {},
            "rule_def_id": "somestring",
            "severity": 1,
            "tags": [
                "somestring",
                "somestring"
            ]
        },
        "description": "somestring",
        "metadata": {
            "def_name": "somestring"
        },
        "name": "somestring"
    }
]

POST ``/api/v2/analytics/configuration/ruleassociation``

Request

Headers

x-account: Generated header parameter. Example value ='a23da25e-c0cc-11ea-9866-26b621aa8d0e'
authorization: Generated header parameter. Example value ='Session 53a1e8e3-ec79-4ea4-ab71-15362f5176f7'

Body

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

CreateAlertRequestDefinition

description

No

string

metadata

No

CreateAlertRequestMetadata

type

No

string

{
    "account_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "account_info": {
            "device_cluster_name": "somestring",
            "device_name": "somestring",
            "partition_name": "somestring",
            "provider_name": "somestring",
            "tenant_name": "somestring"
        },
        "action_def_id": [
            "somestring",
            "somestring"
        ],
        "action_frequency": {},
        "condition_text": "somestring",
        "filter": {
            "account_id": "somestring",
            "cluster_id": [
                "somestring",
                "somestring"
            ],
            "device_uuid": [
                "somestring",
                "somestring"
            ]
        },
        "hierarchyTree": {},
        "rule_def_id": "somestring",
        "severity": 1,
        "tags": [
            "somestring",
            "somestring"
        ]
    },
    "description": "somestring",
    "metadata": {
        "def_name": "somestring"
    },
    "type": "somestring"
}

Responses

200

Type: CreateAlertResponse

Example:

{
    "account_id": "somestring",
    "created_on": "somestring",
    "def_id": "somestring",
    "def_name": "somestring",
    "definition": {
        "account_info": {
            "device_cluster_name": "somestring",
            "device_name": "somestring",
            "partition_name": "somestring",
            "provider_name": "somestring",
            "tenant_name": "somestring"
        },
        "action_def_id": [
            "somestring",
            "somestring"
        ],
        "action_frequency": {},
        "condition_text": "somestring",
        "filter": {
            "account_id": "somestring",
            "cluster_id": [
                "somestring",
                "somestring"
            ],
            "device_uuid": [
                "somestring",
                "somestring"
            ]
        },
        "hierarchyTree": {},
        "rule_def_id": "somestring",
        "severity": 1,
        "tags": [
            "somestring",
            "somestring"
        ]
    },
    "description": "somestring",
    "metadata": {
        "def_name": "somestring"
    },
    "name": "somestring",
    "type": "somestring"
}

Data Structures

Create Alert Request Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

def_name

No

string

definition

No

CreateAlertRequestDefinition

description

No

string

metadata

No

CreateAlertRequestMetadata

type

No

string

Create Alert Request Account Info Model Structure

Name

Required

Type

Format

Properties

Description

device_cluster_name

No

string

device_name

No

string

partition_name

No

string

provider_name

No

string

tenant_name

No

string

Create Alert Request Action Frequency Model Structure

Create Alert Request Definition Model Structure

Name

Required

Type

Format

Properties

Description

account_info

No

CreateAlertRequestAccountInfo

action_def_id

No

array of string

action_frequency

No

CreateAlertRequestActionFrequency

condition_text

No

string

filter

No

CreateAlertRequestFilter

hierarchyTree

No

CreateAlertRequestHierarchyTree

rule_def_id

No

string

severity

No

integer

int32

tags

No

array of string

Create Alert Request Filter Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

cluster_id

No

array of string

device_uuid

No

array of string

Create Alert Request Hierarchy Tree Model Structure

Create Alert Request Metadata Model Structure

Name

Required

Type

Format

Properties

Description

def_name

No

string

Create Alert Response Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

CreateAlertResponseDefinition

description

No

string

metadata

No

CreateAlertResponseMetadata

name

No

string

type

No

string

Create Alert Response Definition Model Structure

Name

Required

Type

Format

Properties

Description

account_info

No

CreateAlertResponseDefinitionAccountInfo

action_def_id

No

array of string

action_frequency

No

CreateAlertResponseDefinitionActionFrequency

condition_text

No

string

filter

No

CreateAlertResponseDefinitionFilter

hierarchyTree

No

CreateAlertResponseDefinitionHierarchyTree

rule_def_id

No

string

severity

No

integer

int32

tags

No

array of string

Create Alert Response Definition Account Info Model Structure

Name

Required

Type

Format

Properties

Description

device_cluster_name

No

string

device_name

No

string

partition_name

No

string

provider_name

No

string

tenant_name

No

string

Create Alert Response Definition Action Frequency Model Structure

Create Alert Response Definition Filter Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

cluster_id

No

array of string

device_uuid

No

array of string

Create Alert Response Definition Hierarchy Tree Model Structure

Create Alert Response Metadata Model Structure

Name

Required

Type

Format

Properties

Description

def_name

No

string

Tenant Alerts Definition Model Structure

Name

Required

Type

Format

Properties

Description

account_info

No

TenantAlertsDefinitionAccountInfo

action_def_id

No

array of string

action_frequency

No

TenantAlertsDefinitionActionFrequency

condition_text

No

string

filter

No

TenantAlertsDefinitionFilter

hierarchyTree

No

TenantAlertsDefinitionHierarchyTree

rule_def_id

No

string

severity

No

integer

int32

tags

No

array of string

Tenant Alerts Definition Account Info Model Structure

Name

Required

Type

Format

Properties

Description

device_cluster_name

No

string

device_name

No

string

partition_name

No

string

provider_name

No

string

tenant_name

No

string

Tenant Alerts Definition Action Frequency Model Structure

Tenant Alerts Definition Filter Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

cluster_id

No

array of string

device_uuid

No

array of string

Tenant Alerts Definition Hierarchy Tree Model Structure

Tenant Alerts List Model Structure

Name

Required

Type

Format

Properties

Description

account_id

No

string

created_on

No

string

def_id

No

string

def_name

No

string

definition

No

TenantAlertsDefinition

description

No

string

metadata

No

TenantAlertsMetadata

name

No

string

Tenant Alerts Metadata Model Structure

Name

Required

Type

Format

Properties

Description

def_name

No

string