Cloudflare/mnm
@swamp/cloudflare/mnmv2026.10.23.1
01README
Cloudflare mnm infrastructure models
02Release Notes
- Updated: rules
03Behaviors
@swamp/cloudflare/mnm/rulesv2026.10.23.1rules.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| 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. |
| bandwidth_threshold? | 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. |
| duration? | enum | 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"]. |
| 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. |
| packet_threshold? | 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. |
| prefix_match? | enum | Prefix match type to be applied for a prefix auto advertisement when using an advanced_ddos rule. |
| prefixes? | array | |
| type? | enum | MNM rule type. |
| zscore_sensitivity? | enum | Level of sensitivity set for zscore rules. |
| zscore_target? | enum | Target of the zscore rule analysis. |
| apiToken? | string | Cloudflare API token; overrides the CLOUDFLARE_API_TOKEN environment variable. Wire with a vault.get(...) expression to source it from a vault. |
| apiKey? | string | Cloudflare API key for the legacy key+email auth path; overrides the CLOUDFLARE_API_KEY environment variable. Wire with a vault.get(...) expression. Requires email. |
| email? | string | Cloudflare account email for the legacy key+email auth path; overrides the CLOUDFLARE_EMAIL environment variable. Requires apiKey. |
fn create()
Create a Rules
fn get(id: string)
Get a Rules
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Rules |
fn lookup(allowMissing?: boolean)
Look up an existing Rules by matching global argument values and import it into state
| Argument | Type | Description |
|---|---|---|
| allowMissing? | boolean | Succeed and record found: false in lookupResult when nothing matches, instead of failing |
fn adopt(id: string)
Import an existing Rules by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Rules to import |
fn update(identifier?: string)
Update Rules attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Rules by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Rules
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Rules |
fn sync(identifier?: string)
Sync Rules state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Rules by id (e.g. one discovered by list) |
Resources
state(infinite)— Rules resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: rules
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: rules
2026.09.29.1
- Updated: rules
2026.07.21.1
- Updated: rules
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: rules
2026.05.29.1
- Updated: rules
2026.05.22.1
- Added: rules
05Stats
A
100 / 100
Downloads
25
Archive size
13.3 KB
Verified by Swamp
- Has README or module doc2/2earned
- README has a code example1/1earned
- README is substantive1/1earned
- Most symbols documented1/1earned
- No slow types (deprecated)1/1earned
- Dependencies pass trust audit2/2earned
- Docs keep secrets in a vault1/1earned
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License2/2earned
- Verified public repository2/2earned
06Platforms
07Labels