--- title: "updateAnomalyRule" description: "Update an anomaly rule" canonical: "https://pgbeam.com/docs/ts-sdk/anomalies/updateAnomalyRule" last-updated: "2026-09-25T00:34:28.000Z" --- # updateAnomalyRule > Update an anomaly rule URL: https://pgbeam.com/docs/ts-sdk/anomalies/updateAnomalyRule Replaces the rule's scope, metric and sensitivity. A rule whose enabled flag is turned off silences its metric for its scope rather than being deactivated. ## Usage ## Parameters Parameter Type Required Description pathParams.project\_id `string` Yes Unique project identifier (prefixed, e.g. prj\_xxx). pathParams.anomaly\_rule\_id `string` Yes Unique anomaly rule identifier (prefixed, e.g. anr\_xxx). body.credential\_id `string` No Agent credential to scope the rule to. Null or omitted applies it to every credential in the project. The credential must belong to this project. body.metric `AnomalyMetric` Yes One of the five detection metrics. A rule retunes how sensitive one of them is; it adds no detection algorithm and no alert kind. body.sigma\_threshold `number` No N in the "mean + N \* dispersion" spike rule. Must be greater than zero; the detector reads any value at or below zero as "use the default", so a stored zero could never mean what setting it would suggest. Rejected for distinct\_shapes and active\_hours, which have no rate for sigma to put a threshold on. Null or omitted leaves the deployment default in place. body.floor `number` No Absolute floor below which the metric never alerts. Must be greater than zero, for the same reason as sigma\_threshold. Rejected for distinct\_shapes and active\_hours, which have no rate for a floor to bound. Null or omitted leaves the deployment default in place. body.enabled `boolean` No False silences this metric for this scope. The baseline keeps advancing while it is silenced, so re-enabling resumes from the existing history rather than a cold warm-up. ## Response `Promise`: updated anomaly rule. ## Example ## Errors Status Description 400 The request was rejected. `code` is `INVALID_INPUT`, and `errors` names the offending fields when the failure was a validation one. 401 Missing or invalid authentication. `code` is `UNAUTHORIZED`. 403 The caller is authenticated but not allowed to perform this operation. `code` is `FORBIDDEN` when the caller's role is insufficient, and `PLAN_LIMIT_REACHED` when the organization's plan is what stands in the way. The two are answered differently, so branch on the code rather than the status. 404 The resource does not exist, or the caller is not entitled to know that it does. `code` is `NOT_FOUND`. 409 The request conflicts with the current state. `code` distinguishes the cases: `RESOURCE_EXISTS` for a name or value already in use, `INVALID_STATE` for a resource that is no longer in a state that allows the operation, and `IDEMPOTENCY_KEY_REUSED` for a retry whose body does not match the request the key was first used for. 412 The `If-Match` entity tag does not match the current representation, so the resource changed after the read this write was based on. Nothing was modified. `code` is `PRECONDITION_FAILED`. Re-read the resource, re-apply the change, and retry with the new tag. 413 The request body exceeds the 2 MB limit. `code` is `PAYLOAD_TOO_LARGE`. 415 The request body is not JSON, or carries a body without declaring a Content-Type. `code` is `UNSUPPORTED_MEDIA_TYPE`. 500 The request failed for a reason on our side. `code` is `INTERNAL_ERROR`. Quote `request_id` when reporting it.