--- title: "Update Alert Privacy Rule" method: PUT path: "/alert-privacy-rule/{id}" tags: ["Alert Privacy Rule"] --- # Update Alert Privacy Rule `PUT /alert-privacy-rule/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/alert-privacy-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 Privacy Rule ## Path parameters - `id` string, uuid, required ## Request body - object - `data` AlertPrivacyRuleUpdateSchema, required: Update schema for AlertPrivacyRule model. Update - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `name` string: Name of this alert privacy rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `description` string: Description of this alert privacy rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitors` object[]: Only trigger for alerts from these monitors. Leave empty to match alerts from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertSeverities` object[]: Only trigger for alerts with these severities. Leave empty to match alerts of any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertLabels` object[]: Only trigger for alerts that have at least one of these labels. Leave empty to match regardless of alert labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `monitorLabels` object[]: Only trigger for alerts from monitors that have at least one of these labels. Leave empty to match regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertTitlePattern` string: Regex (case-insensitive) matched against the alert title. Leave empty to match any title. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `alertDescriptionPattern` string: Regex (case-insensitive) matched against the alert description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitorNamePattern` string: Regex (case-insensitive) matched against the alert's monitor name. Leave empty to match any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitorDescriptionPattern` string: Regex (case-insensitive) matched against the alert's monitor description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] ## Response `200` Updated successfully - object - `data` AlertPrivacyRuleReadSchema: Read schema for AlertPrivacyRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this alert privacy rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `description` string: Description of this alert privacy rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitors` object[]: Only trigger for alerts from these monitors. Leave empty to match alerts from any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertSeverities` object[]: Only trigger for alerts with these severities. Leave empty to match alerts of any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertLabels` object[]: Only trigger for alerts that have at least one of these labels. Leave empty to match regardless of alert labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `monitorLabels` object[]: Only trigger for alerts from monitors that have at least one of these labels. Leave empty to match regardless of monitor labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `id` string - `alertTitlePattern` string: Regex (case-insensitive) matched against the alert title. Leave empty to match any title. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `alertDescriptionPattern` string: Regex (case-insensitive) matched against the alert description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitorNamePattern` string: Regex (case-insensitive) matched against the alert's monitor name. Leave empty to match any monitor. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy Rule] - `monitorDescriptionPattern` string: Regex (case-insensitive) matched against the alert's monitor description. Leave empty to match any description. Permissions - Create: [Project Owner, Project Admin, Create Alert Privacy Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Privacy Rule], Update: [Project Owner, Project Admin, Edit Alert Privacy 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 Privacy 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)