--- title: "Update Metric Recording Rule" method: PUT path: "/metric-recording-rule/{id}" tags: ["Metric Recording Rule"] --- # Update Metric Recording Rule `PUT /metric-recording-rule/{id}` ## Request - Base URL: `https://oneuptime.com/api` - URL: `https://oneuptime.com/api/metric-recording-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 Metric Recording Rule ## Path parameters - `id` string, uuid, required ## Request body - object - `data` MetricRecordingRuleUpdateSchema, required: Update schema for MetricRecordingRule model. Update - `name` string: Friendly name for this rule. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `description` string: What this recording rule computes and why. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `outputMetricName` string: Name of the new metric this rule writes (e.g. http.error_rate). Leave it out and it is made from the rule's name - HTTP error rate becomes http_error_rate, with _2, _3 and so on added when another recording rule of the project already writes it. Keep it unique per project. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `definition` object: Sources (aliased input metrics), arithmetic expression, and optional group-by attribute. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `isEnabled` boolean: Whether this rule is evaluated by the recording rule cron. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `sortOrder` number: Not read when rules are evaluated: every enabled rule is evaluated each minute, on its own, whatever this holds. The dashboard lists rules by name. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] ## Response `200` Updated successfully - object - `data` MetricRecordingRuleReadSchema: Read schema for MetricRecordingRule model. Read - `_id` string, uuid: ID of this object. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `createdAt` object: Date and Time when the object was created. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `updatedAt` object: Date and Time when the object was updated. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `deletedAt` object: Date and Time when the object was deleted. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `projectId` string, uuid: ID of the project this recording rule belongs to. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [No access - you don't have permission for this operation] - `name` string, required: Friendly name for this rule. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `description` string: What this recording rule computes and why. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `outputMetricName` string: Name of the new metric this rule writes (e.g. http.error_rate). Leave it out and it is made from the rule's name - HTTP error rate becomes http_error_rate, with _2, _3 and so on added when another recording rule of the project already writes it. Keep it unique per project. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `definition` object: Sources (aliased input metrics), arithmetic expression, and optional group-by attribute. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `isEnabled` boolean: Whether this rule is evaluated by the recording rule cron. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `sortOrder` number: Not read when rules are evaluated: every enabled rule is evaluated each minute, on its own, whatever this holds. The dashboard lists rules by name. Permissions - Create: [Project Owner, Project Admin, Create Metric Recording Rule], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [Project Owner, Project Admin, Edit Metric Recording Rule] - `createdByUserId` string, uuid: ID of the user who created this rule. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording Rule], Update: [No access - you don't have permission for this operation] - `deletedByUserId` string, uuid: ID of the user who deleted this rule. Permissions - Create: [No access - you don't have permission for this operation], Read: [Project Owner, Project Admin, Project Member, Viewer, Telemetry Admin, Telemetry Member, Telemetry Viewer, Read Metric Recording 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)