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

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

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

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

namestringnullable

tagsstring[]nullable

notestringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterDetail

object

aggregationstringnullable

idstringnullable

namestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resource

object

idstring[]nullable

namestring[]nullable

vdcstringnullable

vmstring[]nullable

metric

object

namestringnullable

typestringnullable

rulestringnullable

thesholdnullable

umstringnullable

durationstringnullable

statestringnullable

notify

object

emailbooleannullable

smsbooleannullable

panelbooleannullable

autoscalingDbaasbooleannullable

autoscalingDbaasValueint32nullable

text/json

Body

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

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

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

namestringnullable

tagsstring[]nullable

notestringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterDetail

object

aggregationstringnullable

idstringnullable

namestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resource

object

idstring[]nullable

namestring[]nullable

vdcstringnullable

vmstring[]nullable

metric

object

namestringnullable

typestringnullable

rulestringnullable

thesholdnullable

umstringnullable

durationstringnullable

statestringnullable

notify

object

emailbooleannullable

smsbooleannullable

panelbooleannullable

autoscalingDbaasbooleannullable

autoscalingDbaasValueint32nullable

application/*+json

Body

metadata

object

Metadata of the resource

namestring

Name of the resource

location

object

Contains information about the Region of a resource

valuestring

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

• ITBG-Bergamo

For more information, check the documentation.

tagsstring[]nullable

List of tags for the resource

properties

object

linkedResources

object[]

nullable

Array [

uristringnullable

Uri of the resource to link

]

alertInfo

object

ruleInfo

object

namestringnullable

tagsstring[]nullable

notestringnullable

serviceCategorystringnullable

serviceTypologystringnullable

clusterDetail

object

aggregationstringnullable

idstringnullable

namestringnullable

nodePoolstringnullable

serviceNumberint32nullable

resource

object

idstring[]nullable

namestring[]nullable

vdcstringnullable

vmstring[]nullable

metric

object

namestringnullable

typestringnullable

rulestringnullable

thesholdnullable

umstringnullable

durationstringnullable

statestringnullable

notify

object

emailbooleannullable

smsbooleannullable

panelbooleannullable

autoscalingDbaasbooleannullable

autoscalingDbaasValueint32nullable

Responses

201

Created

application/json

Schema

Schema

namestringnullable
tagsstring[]nullable
descriptionstringnullable
usernamestringnullable
tenantstringnullable
companystringnullable
serviceCategorystringnullable
serviceTypologystringnullable
clusterTypologystringnullable
clusterstringnullable
clusternamestringnullable
nodePoolstringnullable
serviceNumberint32nullable
resourceIdstring[]nullable
resourceNamestring[]nullable
resourceTypologystringnullable
vdcstringnullable
vmstring[]nullable
metricstringnullable
lastReceptiondate-timenullable
lastActivationdate-timenullable
creationDatetimedate-timenullable
lastEditdate-timenullable
deletionDatedate-timenullable
rulestringnullable
thesholdint64nullable
umstringnullable
durationstringnullable
statestringnullable
emailbooleannullable
emailValuestringnullable
smsbooleannullable
smsValuestringnullable
panelbooleannullable
hiddenbooleannullable

alertActions

object[]

nullable

Array [

actionTypeActionType (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

typestringnullable
titlestringnullable
statusint32nullable
detailstringnullable
instancestringnullable
property name*any

Example (from schema)

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

500

Server Error