---
title: Update rule
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Magic Network Monitoring](https://developers.cloudflare.com/api/resources/magic_network_monitoring)
[Rules](https://developers.cloudflare.com/api/resources/magic_network_monitoring/subresources/rules)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Update rule
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`
##### P ath ParametersExpand Collapse
account\_id: string
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)
rule\_id: 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)>)
##### Body ParametersJSONExpand Collapse
automatic\_advertisement: boolean
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](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20automatic_advertisement%20%3E%20(schema)>)
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](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20name%20%3E%20(schema)>)
prefixes: array of string
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20prefixes%20%3E%20(schema)>)
type: "threshold"or "zscore"or "advanced\_ddos"
MNM rule type.
One of the following:
"threshold"
Link to this property
"zscore"
Link to this property
"advanced\_ddos"
Link to this property
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20type%20%3E%20(schema)>)
bandwidth\_threshold: optional number
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](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20bandwidth_threshold%20%3E%20(schema)>)
duration: optional "1m"or "5m"or "10m"or 5 more
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:
"1m"
Link to this property
"5m"
Link to this property
"10m"
Link to this property
"15m"
Link to this property
"20m"
Link to this property
"30m"
Link to this property
"45m"
Link to this property
"60m"
Link to this property
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20duration%20%3E%20(schema)>)
packet\_threshold: optional number
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](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20packet_threshold%20%3E%20(schema)>)
prefix\_match: optional "exact"or "subnet"or "supernet"
Prefix match type to be applied for a prefix auto advertisement when using an advanced\_ddos rule.
One of the following:
"exact"
Link to this property
"subnet"
Link to this property
"supernet"
Link to this property
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20prefix_match%20%3E%20(schema)>)
zscore\_sensitivity: optional "low"or "medium"or "high"
Level of sensitivity set for zscore rules.
One of the following:
"low"
Link to this property
"medium"
Link to this property
"high"
Link to this property
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20zscore_sensitivity%20%3E%20(schema)>)
zscore\_target: optional "bits"or "packets"
Target of the zscore rule analysis.
One of the following:
"bits"
Link to this property
"packets"
Link to this property
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(params)%200%20%3E%20(param)%20zscore_target%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
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(network%20schema)%20%3E%20(property)%20errors>)
messages: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
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(network%20schema)%20%3E%20(property)%20messages>)
result: MagicNetworkMonitoringRule { id, automatic\_advertisement, name, 8 more }
id: string
The id of the rule. Must be unique.
Link to this property
automatic\_advertisement: boolean
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: array of string
Link to this property
type: "threshold"or "zscore"or "advanced\_ddos"
MNM rule type.
One of the following:
"threshold"
Link to this property
"zscore"
Link to this property
"advanced\_ddos"
Link to this property
Link to this property
bandwidth\_threshold: optional number
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: optional "1m"or "5m"or "10m"or 5 more
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:
"1m"
Link to this property
"5m"
Link to this property
"10m"
Link to this property
"15m"
Link to this property
"20m"
Link to this property
"30m"
Link to this property
"45m"
Link to this property
"60m"
Link to this property
Link to this property
packet\_threshold: optional number
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
prefix\_match: optional "exact"or "subnet"or "supernet"
Prefix match type to be applied for a prefix auto advertisement when using an advanced\_ddos rule.
One of the following:
"exact"
Link to this property
"subnet"
Link to this property
"supernet"
Link to this property
Link to this property
zscore\_sensitivity: optional "low"or "medium"or "high"
Level of sensitivity set for zscore rules.
One of the following:
"low"
Link to this property
"medium"
Link to this property
"high"
Link to this property
Link to this property
zscore\_target: optional "bits"or "packets"
Target of the zscore rule analysis.
One of the following:
"bits"
Link to this property
"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(network%20schema)%20%3E%20(property)%20result>)
success: true
Whether the API call was successful
[Link to this property](<#(resource)%20magic_network_monitoring.rules%20%3E%20(method)%20edit%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
### Update rule
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/mnm/rules/$RULE_ID \
-X PATCH \
-H 'Content-Type: application/json' \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
-d '{
"automatic_advertisement": true,
"name": "my_rule_1",
"prefixes": [
"203.0.113.1/32"
],
"type": "zscore",
"bandwidth_threshold": 1000,
"packet_threshold": 10000,
"prefix_match": "exact",
"zscore_sensitivity": "high",
"zscore_target": "bits"
}'
```
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
}
```