--- title: "Update Alert Incident Rule" method: PUT path: "/alert-incident-rule/{id}" tags: ["Alert Incident Rule"] --- # Update Alert Incident Rule `PUT /alert-incident-rule/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/alert-incident-rule/{id}` - Auth: API key in header `APIKey` - TypeScript: (a function with typed inputs; its response is checked against the schema) Endpoint to update an existing Alert Incident Rule ## Path parameters - `id` string, uuid, required ## Request body - object - `data` AlertIncidentRuleUpdateSchema, required: Update schema for AlertIncidentRule model. Update - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `name` string: Name of this alert incident rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `description` string: Description of this alert incident rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `order` number: Where this rule sits in the list. Rules are checked from the top of the list down, lowest number first, and the first enabled one that matches an alert decides. A new rule is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitors` object[]: Only declare incidents from alerts raised by these monitors. Leave empty to match alerts from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertSeverities` object[]: Only declare incidents from alerts with these severities. Leave empty to match alerts of any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertLabels` object[]: Only declare incidents from alerts that have at least one of these labels. Leave empty to match alerts regardless of alert labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `monitorLabels` object[]: Only declare incidents from alerts raised by monitors that have at least one of these labels. Leave empty to match alerts regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertTitlePattern` string: Regular expression pattern to match alert titles. Leave empty to match any title. Example: 'CPU.*high' matches titles containing 'CPU' followed by 'high'. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `alertDescriptionPattern` string: Regular expression pattern to match alert descriptions. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitorNamePattern` string: Regular expression pattern to match monitor names. Leave empty to match any monitor name. Example: 'prod-.*' matches monitors starting with 'prod-'. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitorDescriptionPattern` string: Regular expression pattern to match monitor descriptions. Leave empty to match any monitor description. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `incidentSeverityId` string, uuid: ID of the severity of the incidents this rule declares. Empty gives each incident the severity that corresponds to its alert's. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `declareAfterInMinutes` number: How long a matching alert must stay unresolved before the incident is declared, in whole minutes from when the alert was created. 0 declares it as soon as the alert is created. An alert resolved before the wait is up never becomes an incident. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `showIncidentOnStatusPage` boolean: Whether the incidents this rule declares are shown on the status pages that list their monitor, and their subscribers notified, as for any incident declared with Show on Status Page on. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] ## Response `200` Updated successfully - object - `data` AlertIncidentRuleReadSchema: Read schema for AlertIncidentRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this alert incident rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `description` string: Description of this alert incident rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `order` number: Where this rule sits in the list. Rules are checked from the top of the list down, lowest number first, and the first enabled one that matches an alert decides. A new rule is added to the end of the list. Setting a number another one already has puts it in that place, and the ones in the way move one place along to make room. In the dashboard, drag the rows to reorder them. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitors` object[]: Only declare incidents from alerts raised by these monitors. Leave empty to match alerts from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertSeverities` object[]: Only declare incidents from alerts with these severities. Leave empty to match alerts of any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertLabels` object[]: Only declare incidents from alerts that have at least one of these labels. Leave empty to match alerts regardless of alert labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `monitorLabels` object[]: Only declare incidents from alerts raised by monitors that have at least one of these labels. Leave empty to match alerts regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `id` string - `alertTitlePattern` string: Regular expression pattern to match alert titles. Leave empty to match any title. Example: 'CPU.*high' matches titles containing 'CPU' followed by 'high'. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `alertDescriptionPattern` string: Regular expression pattern to match alert descriptions. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitorNamePattern` string: Regular expression pattern to match monitor names. Leave empty to match any monitor name. Example: 'prod-.*' matches monitors starting with 'prod-'. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `monitorDescriptionPattern` string: Regular expression pattern to match monitor descriptions. Leave empty to match any monitor description. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `incidentSeverityId` string, uuid: ID of the severity of the incidents this rule declares. Empty gives each incident the severity that corresponds to its alert's. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `declareAfterInMinutes` number: How long a matching alert must stay unresolved before the incident is declared, in whole minutes from when the alert was created. 0 declares it as soon as the alert is created. An alert resolved before the wait is up never becomes an incident. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `showIncidentOnStatusPage` boolean: Whether the incidents this rule declares are shown on the status pages that list their monitor, and their subscribers notified, as for any incident declared with Show on Status Page on. Permissions - Create: [Project Owner, Project Admin, Create Alert Incident Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [Project Owner, Project Admin, Edit Alert Incident Rule] - `createdByUserId` string, uuid: User ID who created this object (if this object was created by a User). Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Incident Rule], Update: [No access - you don't have permission for this operation] ## Other responses - `400`: Bad request. This response indicates that the request was malformed or contained invalid data. - `401`: Unauthorized. This response indicates that the request requires user authentication. - `402`: Payment Required. This response indicates that the request requires payment or a valid subscription. - `403`: Forbidden. This response indicates that the server understood the request, but refuses to authorize it. - `404`: Not found. The record does not exist, belongs to another project, or is one you may not read - the same answer for each. - `405`: Project not found. This response indicates that the requested project does not exist or is not accessible. - `408`: Request Timeout. This response indicates that the server timed out waiting for the request. - `415`: Unable to reach server. This response indicates that the server is currently unreachable or down. - `422`: Not authorized. This response indicates that the user does not have permission to access the requested resource. - `500`: Internal Server Error. This response indicates that the server encountered an unexpected condition that prevented it from fulfilling the request. --- [API](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification.md) - [All operations](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/llms.txt) - [OpenAPI document](https://skmtc.dev/oneuptime/apis/oneuptime-openapi-specification/revisions/ba3307d00304?raw)