Pulsar Docs

Update Alert Group

PATCH
/v1/alerts/{id}

This endpoint requires authentication — use the Login page at the top of the API Reference, or paste a token in the Authorization section below.

Partial, group-wide update. metricIds, personaIds and params replace the existing set wholesale when present. Answers in the same detail shape the detail read returns.

Authorization

bearerAuth admin, superadmin, superuser
Authorization<token>

In: header

Scope: admin, superadmin, superuser

Path Parameters

id*string

The ID.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Partial, group-wide update. Only fields actually present in the request body are forwarded to draco; metricIds, personaIds and params replace the existing set wholesale when present.

Response Body

application/json

curl -X PATCH "https://example.com/v1/alerts/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "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}