Create Alert Rule

POST 
/projects/:projectId/providers/Aruba.Insight/alertRules

Create Alert Rule

Request

Path Parameters

projectId stringrequired
Default value: *

Query Parameters

api-version string
The requested API version
Default value: 1.0

application/json

Body

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

name stringnullable

tags string[]nullable

note stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterDetail

object

aggregation stringnullable

id stringnullable

name stringnullable

nodePool stringnullable

serviceNumber int32nullable

resource

object

id string[]nullable

name string[]nullable

vdc stringnullable

vm string[]nullable

metric

object

name stringnullable

type stringnullable

rule stringnullable

theshold nullable

um stringnullable

duration stringnullable

state stringnullable

notify

object

email booleannullable

sms booleannullable

panel booleannullable

autoscalingDbaas booleannullable

autoscalingDbaasValue int32nullable

text/json

Body

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

name stringnullable

tags string[]nullable

note stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterDetail

object

aggregation stringnullable

id stringnullable

name stringnullable

nodePool stringnullable

serviceNumber int32nullable

resource

object

id string[]nullable

name string[]nullable

vdc stringnullable

vm string[]nullable

metric

object

name stringnullable

type stringnullable

rule stringnullable

theshold nullable

um stringnullable

duration stringnullable

state stringnullable

notify

object

email booleannullable

sms booleannullable

panel booleannullable

autoscalingDbaas booleannullable

autoscalingDbaasValue int32nullable

application/*+json

Body

metadata

object

Metadata of the resource

name string

Name of the resource

location

object

Contains information about the Region of a resource

value string

Value of the region in which the resource will be located. Available regions at present:

• ITBG-Bergamo

For more information, check the documentation.

tags string[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uri stringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

name stringnullable

tags string[]nullable

note stringnullable

serviceCategory stringnullable

serviceTypology stringnullable

clusterDetail

object

aggregation stringnullable

id stringnullable

name stringnullable

nodePool stringnullable

serviceNumber int32nullable

resource

object

id string[]nullable

name string[]nullable

vdc stringnullable

vm string[]nullable

metric

object

name stringnullable

type stringnullable

rule stringnullable

theshold nullable

um stringnullable

duration stringnullable

state stringnullable

notify

object

email booleannullable

sms booleannullable

panel booleannullable

autoscalingDbaas booleannullable

autoscalingDbaasValue int32nullable

Responses

201

Created

application/json

Schema

Schema

name stringnullable
tags string[]nullable
description stringnullable
username stringnullable
tenant stringnullable
company stringnullable
serviceCategory stringnullable
serviceTypology stringnullable
clusterTypology stringnullable
cluster stringnullable
clustername stringnullable
nodePool stringnullable
serviceNumber int32nullable
resourceId string[]nullable
resourceName string[]nullable
resourceTypology stringnullable
vdc stringnullable
vm string[]nullable
metric stringnullable
lastReception date-timenullable
lastActivation date-timenullable
creationDatetime date-timenullable
lastEdit date-timenullable
deletionDate date-timenullable
rule stringnullable
theshold int64nullable
um stringnullable
duration stringnullable
state stringnullable
email booleannullable
emailValue stringnullable
sms booleannullable
smsValue stringnullable
panel booleannullable
hidden booleannullable

alertActions

object[]

nullable

Array [

actionType ActionType (string)

Possible values: [NotificationPanel, SendEmail, SendSms, AutoscalingDbaas]

parameters

object

nullable

property name* string

]

Example (from schema)

{
  "name": "string",
  "tags": [
    "string"
  ],
  "description": "string",
  "username": "string",
  "tenant": "string",
  "company": "string",
  "serviceCategory": "string",
  "serviceTypology": "string",
  "clusterTypology": "string",
  "cluster": "string",
  "clustername": "string",
  "nodePool": "string",
  "serviceNumber": 0,
  "resourceId": [
    "string"
  ],
  "resourceName": [
    "string"
  ],
  "resourceTypology": "string",
  "vdc": "string",
  "vm": [
    "string"
  ],
  "metric": "string",
  "lastReception": "2024-07-29T15:51:28.071Z",
  "lastActivation": "2024-07-29T15:51:28.071Z",
  "creationDatetime": "2024-07-29T15:51:28.071Z",
  "lastEdit": "2024-07-29T15:51:28.071Z",
  "deletionDate": "2024-07-29T15:51:28.071Z",
  "rule": "string",
  "theshold": 0,
  "um": "string",
  "duration": "string",
  "state": "string",
  "email": true,
  "emailValue": "string",
  "sms": true,
  "smsValue": "string",
  "panel": true,
  "hidden": true,
  "alertActions": [
    {
      "actionType": "NotificationPanel",
      "parameters": {}
    }
  ]
}

400

Bad Request

application/json

Schema

Schema

type stringnullable
title stringnullable
status int32nullable
detail stringnullable
instance stringnullable
property name* any

Example (from schema)

{
  "type": "string",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}

500

Server Error

Loading...