--- title: "Update Alert Episode On-Call Rule" method: PUT path: "/alert-episode-on-call-rule/{id}" tags: ["Alert Episode On-Call Rule"] --- # Update Alert Episode On-Call Rule `PUT /alert-episode-on-call-rule/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/alert-episode-on-call-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 Episode On-Call Rule ## Path parameters - `id` string, uuid, required ## Request body - object - `data` AlertEpisodeOnCallRuleUpdateSchema, required: Update schema for AlertEpisodeOnCallRule model. Update - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `whenToPage` 'Right Away' | 'Working Hours' | 'After OneUptime AI': When the on-call policies of this rule page: Right Away, as soon as a record matches it; Working Hours, only during the working hours of this rule - a record that matches it outside them is paged about when they begin; or After OneUptime AI, for alert and incident rules - when OneUptime AI may fix what the record is about, it responds first, and the policies page only if it has not resolved the record within the hold time. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `workingHours` object: When this rule may page, when When to Page is Working Hours: the same daily or weekly windows as an on-call schedule layer's restriction times, read in the time zone of this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `workingHoursTimezone` string: The IANA time zone the working hours of this rule are in: Europe/London. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `aiHoldTimeInMinutes` number: When When to Page is After OneUptime AI: how many minutes OneUptime AI may hold the page while it investigates and fixes (1 to 30). Empty: 10. If OneUptime AI has not resolved the record by then, the policies page as usual. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `name` string: Name of this alert episode on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `description` string: Description of this alert episode on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `alertSeverities` object[]: Only trigger for episodes with these severities. Leave empty to match any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string - `episodeLabels` object[]: Only trigger for episodes that have at least one of these labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string - `episodeTitlePattern` string: Regex (case-insensitive) matched against the episode title. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `episodeDescriptionPattern` string: Regex (case-insensitive) matched against the episode description. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `onCallDutyPolicies` object[]: On-call duty policies to execute when an alert episode matches this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string ## Response `200` Updated successfully - object - `data` AlertEpisodeOnCallRuleReadSchema: Read schema for AlertEpisodeOnCallRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `criteria` object: Versioned conditions that determine whether this rule matches a resource. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `whenToPage` 'Right Away' | 'Working Hours' | 'After OneUptime AI': When the on-call policies of this rule page: Right Away, as soon as a record matches it; Working Hours, only during the working hours of this rule - a record that matches it outside them is paged about when they begin; or After OneUptime AI, for alert and incident rules - when OneUptime AI may fix what the record is about, it responds first, and the policies page only if it has not resolved the record within the hold time. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `workingHours` object: When this rule may page, when When to Page is Working Hours: the same daily or weekly windows as an on-call schedule layer's restriction times, read in the time zone of this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `workingHoursTimezone` string: The IANA time zone the working hours of this rule are in: Europe/London. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `aiHoldTimeInMinutes` number: When When to Page is After OneUptime AI: how many minutes OneUptime AI may hold the page while it investigates and fixes (1 to 30). Empty: 10. If OneUptime AI has not resolved the record by then, the policies page as usual. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `projectId` string, uuid: ID of your OneUptime Project in which this object belongs. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Name of this alert episode on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `description` string: Description of this alert episode on-call rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `isEnabled` boolean: Whether this rule is enabled. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `alertSeverities` object[]: Only trigger for episodes with these severities. Leave empty to match any severity. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string - `episodeLabels` object[]: Only trigger for episodes that have at least one of these labels. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string - `episodeTitlePattern` string: Regex (case-insensitive) matched against the episode title. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `episodeDescriptionPattern` string: Regex (case-insensitive) matched against the episode description. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `onCallDutyPolicies` object[]: On-call duty policies to execute when an alert episode matches this rule. Permissions - Create: [Project Owner, Project Admin, Create Alert Episode On-Call Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Alert Admin, Alert Member, Alert Viewer, Read Alert Episode On-Call Rule], Update: [Project Owner, Project Admin, Edit Alert Episode On-Call Rule] - `id` string - `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 Episode On-Call 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)