--- title: Update rule --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/go) [Magic Network Monitoring](https://developers.cloudflare.com/api/go/resources/magic_network_monitoring) [Rules](https://developers.cloudflare.com/api/go/resources/magic_network_monitoring/subresources/rules) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Update rule client.MagicNetworkMonitoring.Rules.Edit(ctx, ruleID, params) (\*[MagicNetworkMonitoringRule](), error) PATCH/accounts/{account\_id}/mnm/rules/{rule\_id} Update a network monitoring rule for account. ##### Security API Email + API Key The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key. **Example:**`X-Auth-Email: user@example.com` The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys. **Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194` ##### Accepted Permissions (at least one required) `Magic Network Monitoring Admin``Magic Network Monitoring Config Write` ##### ParametersExpand Collapse ruleID string The id of the rule. Must be unique. [Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20rule_id%20%3E%20(schema)>)

params RuleEditParams

AccountID param.Field\[string] Path param Link to this property AutomaticAdvertisement param.Field\[bool] Body param: Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit. Link to this property Name param.Field\[string] Body param: The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (\_), dash (-), period (.), and tilde (\~). You can’t have a space in the rule name. Max 256 characters. Link to this property Prefixes param.Field\[\[]string] Body param Link to this property

Type param.Field\[RuleEditParamsType] Body param: MNM rule type.

const RuleEditParamsTypeThreshold RuleEditParamsType = "threshold" Link to this property const RuleEditParamsTypeZscore RuleEditParamsType = "zscore" Link to this property const RuleEditParamsTypeAdvancedDDoS RuleEditParamsType = "advanced\_ddos" Link to this property

Link to this property BandwidthThreshold param.Field\[float64]Optional Body param: The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. minimum1 Link to this property

Duration param.Field\[RuleEditParamsDuration]Optional Body param: The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values \[“1m”,“5m”,“10m”,“15m”,“20m”,“30m”,“45m”,“60m”].

const RuleEditParamsDuration1m RuleEditParamsDuration = "1m" Link to this property const RuleEditParamsDuration5m RuleEditParamsDuration = "5m" Link to this property const RuleEditParamsDuration10m RuleEditParamsDuration = "10m" Link to this property const RuleEditParamsDuration15m RuleEditParamsDuration = "15m" Link to this property const RuleEditParamsDuration20m RuleEditParamsDuration = "20m" Link to this property const RuleEditParamsDuration30m RuleEditParamsDuration = "30m" Link to this property const RuleEditParamsDuration45m RuleEditParamsDuration = "45m" Link to this property const RuleEditParamsDuration60m RuleEditParamsDuration = "60m" Link to this property

Link to this property PacketThreshold param.Field\[float64]Optional Body param: The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. minimum1 Link to this property

PrefixMatch param.Field\[RuleEditParamsPrefixMatch]Optional Body param: Prefix match type to be applied for a prefix auto advertisement when using an advanced\_ddos rule.

const RuleEditParamsPrefixMatchExact RuleEditParamsPrefixMatch = "exact" Link to this property const RuleEditParamsPrefixMatchSubnet RuleEditParamsPrefixMatch = "subnet" Link to this property const RuleEditParamsPrefixMatchSupernet RuleEditParamsPrefixMatch = "supernet" Link to this property

Link to this property

ZscoreSensitivity param.Field\[RuleEditParamsZscoreSensitivity]Optional Body param: Level of sensitivity set for zscore rules.

const RuleEditParamsZscoreSensitivityLow RuleEditParamsZscoreSensitivity = "low" Link to this property const RuleEditParamsZscoreSensitivityMedium RuleEditParamsZscoreSensitivity = "medium" Link to this property const RuleEditParamsZscoreSensitivityHigh RuleEditParamsZscoreSensitivity = "high" Link to this property

Link to this property

ZscoreTarget param.Field\[RuleEditParamsZscoreTarget]Optional Body param: Target of the zscore rule analysis.

const RuleEditParamsZscoreTargetBits RuleEditParamsZscoreTarget = "bits" Link to this property const RuleEditParamsZscoreTargetPackets RuleEditParamsZscoreTarget = "packets" Link to this property

Link to this property

[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

type MagicNetworkMonitoringRule struct{…}

ID string The id of the rule. Must be unique. Link to this property AutomaticAdvertisement bool Toggle on if you would like Cloudflare to automatically advertise the IP Prefixes within the rule via Magic Transit when the rule is triggered. Only available for users of Magic Transit. Link to this property Name string The name of the rule. Must be unique. Supports characters A-Z, a-z, 0-9, underscore (\_), dash (-), period (.), and tilde (\~). You can’t have a space in the rule name. Max 256 characters. Link to this property Prefixes \[]string Link to this property

Type MagicNetworkMonitoringRuleType MNM rule type.

One of the following: const MagicNetworkMonitoringRuleTypeThreshold MagicNetworkMonitoringRuleType = "threshold" Link to this property const MagicNetworkMonitoringRuleTypeZscore MagicNetworkMonitoringRuleType = "zscore" Link to this property const MagicNetworkMonitoringRuleTypeAdvancedDDoS MagicNetworkMonitoringRuleType = "advanced\_ddos" Link to this property

Link to this property BandwidthThreshold float64Optional The number of bits per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. minimum1 Link to this property

Duration MagicNetworkMonitoringRuleDurationOptional The amount of time that the rule threshold must be exceeded to send an alert notification. The final value must be equivalent to one of the following 8 values \[“1m”,“5m”,“10m”,“15m”,“20m”,“30m”,“45m”,“60m”].

One of the following: const MagicNetworkMonitoringRuleDuration1m MagicNetworkMonitoringRuleDuration = "1m" Link to this property const MagicNetworkMonitoringRuleDuration5m MagicNetworkMonitoringRuleDuration = "5m" Link to this property const MagicNetworkMonitoringRuleDuration10m MagicNetworkMonitoringRuleDuration = "10m" Link to this property const MagicNetworkMonitoringRuleDuration15m MagicNetworkMonitoringRuleDuration = "15m" Link to this property const MagicNetworkMonitoringRuleDuration20m MagicNetworkMonitoringRuleDuration = "20m" Link to this property const MagicNetworkMonitoringRuleDuration30m MagicNetworkMonitoringRuleDuration = "30m" Link to this property const MagicNetworkMonitoringRuleDuration45m MagicNetworkMonitoringRuleDuration = "45m" Link to this property const MagicNetworkMonitoringRuleDuration60m MagicNetworkMonitoringRuleDuration = "60m" Link to this property

Link to this property PacketThreshold float64Optional The number of packets per second for the rule. When this value is exceeded for the set duration, an alert notification is sent. Minimum of 1 and no maximum. minimum1 Link to this property

PrefixMatch MagicNetworkMonitoringRulePrefixMatchOptional Prefix match type to be applied for a prefix auto advertisement when using an advanced\_ddos rule.

One of the following: const MagicNetworkMonitoringRulePrefixMatchExact MagicNetworkMonitoringRulePrefixMatch = "exact" Link to this property const MagicNetworkMonitoringRulePrefixMatchSubnet MagicNetworkMonitoringRulePrefixMatch = "subnet" Link to this property const MagicNetworkMonitoringRulePrefixMatchSupernet MagicNetworkMonitoringRulePrefixMatch = "supernet" Link to this property

Link to this property

ZscoreSensitivity MagicNetworkMonitoringRuleZscoreSensitivityOptional Level of sensitivity set for zscore rules.

One of the following: const MagicNetworkMonitoringRuleZscoreSensitivityLow MagicNetworkMonitoringRuleZscoreSensitivity = "low" Link to this property const MagicNetworkMonitoringRuleZscoreSensitivityMedium MagicNetworkMonitoringRuleZscoreSensitivity = "medium" Link to this property const MagicNetworkMonitoringRuleZscoreSensitivityHigh MagicNetworkMonitoringRuleZscoreSensitivity = "high" Link to this property

Link to this property

ZscoreTarget MagicNetworkMonitoringRuleZscoreTargetOptional Target of the zscore rule analysis.

One of the following: const MagicNetworkMonitoringRuleZscoreTargetBits MagicNetworkMonitoringRuleZscoreTarget = "bits" Link to this property const MagicNetworkMonitoringRuleZscoreTargetPackets MagicNetworkMonitoringRuleZscoreTarget = "packets" Link to this property

Link to this property

[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(model)%20magic_network_monitoring_rule%20%3E%20(schema)>) ### Update rule Go HTTPTypeScriptPythonGoTerraform ``` package main import ( "context" "fmt" "github.com/cloudflare/cloudflare-go" "github.com/cloudflare/cloudflare-go/magic_network_monitoring" "github.com/cloudflare/cloudflare-go/option" ) func main() { client := cloudflare.NewClient( option.WithAPIKey("144c9defac04969c7bfad8efaa8ea194"), option.WithAPIEmail("user@example.com"), ) magicNetworkMonitoringRule, err := client.MagicNetworkMonitoring.Rules.Edit( context.TODO(), "2890e6fa406311ed9b5a23f70f6fb8cf", magic_network_monitoring.RuleEditParams{ AccountID: cloudflare.F("6f91088a406011ed95aed352566e8d4c"), AutomaticAdvertisement: cloudflare.F(true), Name: cloudflare.F("my_rule_1"), Prefixes: cloudflare.F([]string{"203.0.113.1/32"}), Type: cloudflare.F(magic_network_monitoring.RuleEditParamsTypeZscore), }, ) if err != nil { panic(err.Error()) } fmt.Printf("%+v\n", magicNetworkMonitoringRule.ID) } ``` 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "2890e6fa406311ed9b5a23f70f6fb8cf", "automatic_advertisement": true, "name": "my_rule_1", "prefixes": [ "203.0.113.1/32" ], "type": "zscore", "bandwidth_threshold": 1000, "duration": "1m", "packet_threshold": 10000, "prefix_match": "exact", "zscore_sensitivity": "high", "zscore_target": "bits" }, "success": true } ``` ##### Returns Examples 200 example ``` { "errors": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "messages": [ { "code": 1000, "message": "message", "documentation_url": "documentation_url", "source": { "pointer": "pointer" } } ], "result": { "id": "2890e6fa406311ed9b5a23f70f6fb8cf", "automatic_advertisement": true, "name": "my_rule_1", "prefixes": [ "203.0.113.1/32" ], "type": "zscore", "bandwidth_threshold": 1000, "duration": "1m", "packet_threshold": 10000, "prefix_match": "exact", "zscore_sensitivity": "high", "zscore_target": "bits" }, "success": true } ```