List rules

client.MagicNetworkMonitoring.Rules.List(ctx, query) (*SinglePage[MagicNetworkMonitoringRule], error)

GET/accounts/{account_id}/mnm/rules

Lists network monitoring rules 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 AdminMagic Network Monitoring Config WriteMagic Network Monitoring Config Read

ParametersExpand Collapse

query RuleListParams

AccountID param.Field[string]

ReturnsExpand Collapse

type MagicNetworkMonitoringRule struct{…}

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.

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.

Prefixes []string

Type MagicNetworkMonitoringRuleType

MNM rule type.

One of the following:

const MagicNetworkMonitoringRuleTypeThreshold MagicNetworkMonitoringRuleType = "threshold"

const MagicNetworkMonitoringRuleTypeZscore MagicNetworkMonitoringRuleType = "zscore"

const MagicNetworkMonitoringRuleTypeAdvancedDDoS MagicNetworkMonitoringRuleType = "advanced_ddos"

ID stringoptional

The id of the rule. Must be unique.

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

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"

const MagicNetworkMonitoringRuleDuration5m MagicNetworkMonitoringRuleDuration = "5m"

const MagicNetworkMonitoringRuleDuration10m MagicNetworkMonitoringRuleDuration = "10m"

const MagicNetworkMonitoringRuleDuration15m MagicNetworkMonitoringRuleDuration = "15m"

const MagicNetworkMonitoringRuleDuration20m MagicNetworkMonitoringRuleDuration = "20m"

const MagicNetworkMonitoringRuleDuration30m MagicNetworkMonitoringRuleDuration = "30m"

const MagicNetworkMonitoringRuleDuration45m MagicNetworkMonitoringRuleDuration = "45m"

const MagicNetworkMonitoringRuleDuration60m MagicNetworkMonitoringRuleDuration = "60m"

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

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"

const MagicNetworkMonitoringRulePrefixMatchSubnet MagicNetworkMonitoringRulePrefixMatch = "subnet"

const MagicNetworkMonitoringRulePrefixMatchSupernet MagicNetworkMonitoringRulePrefixMatch = "supernet"

ZscoreSensitivity MagicNetworkMonitoringRuleZscoreSensitivityoptional

Level of sensitivity set for zscore rules.

One of the following:

const MagicNetworkMonitoringRuleZscoreSensitivityLow MagicNetworkMonitoringRuleZscoreSensitivity = "low"

const MagicNetworkMonitoringRuleZscoreSensitivityMedium MagicNetworkMonitoringRuleZscoreSensitivity = "medium"

const MagicNetworkMonitoringRuleZscoreSensitivityHigh MagicNetworkMonitoringRuleZscoreSensitivity = "high"

ZscoreTarget MagicNetworkMonitoringRuleZscoreTargetoptional

Target of the zscore rule analysis.

One of the following:

const MagicNetworkMonitoringRuleZscoreTargetBits MagicNetworkMonitoringRuleZscoreTarget = "bits"

const MagicNetworkMonitoringRuleZscoreTargetPackets MagicNetworkMonitoringRuleZscoreTarget = "packets"

List rules

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"),
  )
  page, err := client.MagicNetworkMonitoring.Rules.List(context.TODO(), magic_network_monitoring.RuleListParams{
    AccountID: cloudflare.F("6f91088a406011ed95aed352566e8d4c"),
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "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": [
    {
      "automatic_advertisement": true,
      "name": "my_rule_1",
      "prefixes": [
        "203.0.113.1/32"
      ],
      "type": "zscore",
      "id": "2890e6fa406311ed9b5a23f70f6fb8cf",
      "bandwidth_threshold": 1000,
      "duration": "1m",
      "packet_threshold": 10000,
      "prefix_match": "exact",
      "zscore_sensitivity": "high",
      "zscore_target": "bits"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Returns Examples

{
  "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": [
    {
      "automatic_advertisement": true,
      "name": "my_rule_1",
      "prefixes": [
        "203.0.113.1/32"
      ],
      "type": "zscore",
      "id": "2890e6fa406311ed9b5a23f70f6fb8cf",
      "bandwidth_threshold": 1000,
      "duration": "1m",
      "packet_threshold": 10000,
      "prefix_match": "exact",
      "zscore_sensitivity": "high",
      "zscore_target": "bits"
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}