Cloudflare API | Magic Network Monitoring › Rules › List Rules

API Reference

Account & User Management

Resource Sharing

AI

Certificate Management

Certificate Authorities

Client Certificates

Custom Certificates

Custom Hostnames

Keyless Certificates

MTLS Certificates

Origin CA Certificates

Origin Post Quantum Encryption

Origin TLS Client Auth

Cloudflare One

DNS

Account Custom Nameservers

Domain/Zone Management

IP Addresses

Media

Networking

Magic Network Monitoring

Observability

Radar

Routing & Performance

Rules

Cloud Connector

Managed Transforms

URL Normalization

Security

Content Scanning

Leaked Credential Checks

Storage & Databases

Threat Intelligence

Brand Protection

Workers & Pages

Durable Objects

Workers For Platforms

Shared

Magic Network Monitoring

magic_network_monitoring

Magic Network Monitoring

Configs

magic_network_monitoring.configs

Methods

Create Account Configuration -> Envelope<

>

post/accounts/{account_id}/mnm/config

Create a new network monitoring configuration.

Delete Account Configuration -> Envelope<

>

delete/accounts/{account_id}/mnm/config

Delete an existing network monitoring configuration.

Update Account Configuration Fields -> Envelope<

>

patch/accounts/{account_id}/mnm/config

Update fields in an existing network monitoring configuration.

List Account Configuration -> Envelope<

>

get/accounts/{account_id}/mnm/config

Lists default sampling, router IPs and warp devices for account.

Update An Entire Account Configuration -> Envelope<

>

put/accounts/{account_id}/mnm/config

Update an existing network monitoring configuration, requires the entire configuration to be updated at once.

Domain types

Configuration = { default_sampling, name, router_ips, 1 more... }

Magic Network Monitoring Configs

Full

magic_network_monitoring.configs.full

Methods

List Rules And Account Configuration -> Envelope<

>

get/accounts/{account_id}/mnm/config/full

Lists default sampling, router IPs, warp devices, and rules for account.

Magic Network Monitoring

Rules

magic_network_monitoring.rules

Methods

Create Rules -> Envelope<

MagicNetworkMonitoringRule

>

post/accounts/{account_id}/mnm/rules

Create network monitoring rules for account. Currently only supports creating a single rule per API request.

Delete Rule -> Envelope<

MagicNetworkMonitoringRule

>

delete/accounts/{account_id}/mnm/rules/{rule_id}

Delete a network monitoring rule for account.

Update Rule -> Envelope<

MagicNetworkMonitoringRule

>

patch/accounts/{account_id}/mnm/rules/{rule_id}

Update a network monitoring rule for account.

Get Rule -> Envelope<

MagicNetworkMonitoringRule

>

get/accounts/{account_id}/mnm/rules/{rule_id}

List a single network monitoring rule for account.

List Rules -> SinglePage<

MagicNetworkMonitoringRule

>

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 Admin Magic Network Monitoring Config Write Magic Network Monitoring Config Read

Parameters

account_id: string

Response fields

errors: Array<

>

messages: Array<

>

result: Array<

MagicNetworkMonitoringRule

>

success: true

Whether the API call was successful

result_info: { count, page, per_page, 1 more... }

Optional

Request example

curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/mnm/rules \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY"

200Example

{
  "errors": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "messages": [
    {
      "code": 1000,
      "message": "message"
    }
  ],
  "result": [
    {
      "automatic_advertisement": true,
      "duration": "300s",
      "name": "my_rule_1",
      "prefixes": [
        "203.0.113.1/32"
      ],
      "id": "2890e6fa406311ed9b5a23f70f6fb8cf",
      "bandwidth_threshold": 1000,
      "packet_threshold": 10000
    }
  ],
  "success": true,
  "result_info": {
    "count": 1,
    "page": 1,
    "per_page": 20,
    "total_count": 2000
  }
}

Update Rules -> Envelope<

MagicNetworkMonitoringRule

>

put/accounts/{account_id}/mnm/rules

Update network monitoring rules for account.

Domain types

MagicNetworkMonitoringRule = { automatic_advertisement, duration, name, 4 more... }

Magic Network Monitoring Rules

Advertisements

magic_network_monitoring.rules.advertisements

Methods

Update Advertisement For Rule -> Envelope<

>

patch/accounts/{account_id}/mnm/rules/{rule_id}/advertisement

Update advertisement for rule.

Domain types

Advertisement = { automatic_advertisement }