Create Alert Group

Create a v2 alert group spanning one or more machines; answers in the detail shape.

Authorization

bearerAuth admin, superadmin, superuser

Authorization<token>

In: header

Scope: admin, superadmin, superuser

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

changed_by is never accepted here; it comes from the authenticated user, not the request. openTemplateId/resolveTemplateId aren't exposed at this layer yet, so omitting them lets draco use its own defaults.

name*string

metricIds*array<>

alertType*string

params*

A detector's own parameters, e.g. { operator, threshold } for the threshold detector. Left opaque here since draco's alert_types.params_validation JSON Schema is the only validator.

An index signature, not Record<string, unknown>: tsoa emits a Record with no additionalProperties, so its request validator rejects every key. Same trap as MachineMetricsMap.

personaIds?array<string>

description?string

isActive?boolean

aggregationFunction?AggregationFunction

The windowed aggregate an alert reads. last is the newest reading in the window: a cumulative shift-scoped metric already contains every earlier reading, so its average and sum say nothing about the current value.

Value in

"min"
"max"
"avg"
"sum"
"last"

windowSize?number

Formatdouble

emitTimeInterval?number

Formatdouble

openM?number

Formatdouble

openN?number

Formatdouble

notifyOnOpen?boolean

notifyOnResolve?boolean

resetOnIneligible?boolean

Response Body

`application/json`

curl -X POST "https://example.com/v1/alerts" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "metricIds": [      0.1    ],    "alertType": "string",    "params": {      "property1": null,      "property2": null    }  }'

{  "source": "v2",  "id": "string",  "name": "string",  "description": "string",  "isActive": true,  "alertType": "string",  "params": {    "property1": null,    "property2": null  },  "personaIds": [    "string"  ],  "metrics": [    {      "metricId": 0.1,      "machineId": 0.1,      "metricName": "string",      "rowId": 0.1    }  ],  "aggregationFunction": "min",  "windowSize": 0.1,  "emitTimeInterval": 0.1,  "openM": 0.1,  "openN": 0.1,  "notifyOnOpen": true,  "notifyOnResolve": true,  "resetOnIneligible": true}

Create Alert Group

Authorization

Request Body

Response Body

201application/json

`application/json`