Cloudflare/rules
@swamp/cloudflare/rulesv2026.10.23.1
01README
Cloudflare rules infrastructure models
02Release Notes
- Updated: lists
03Behaviors
@swamp/cloudflare/rules/listsv2026.10.23.1lists.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | An informative summary of the list. |
| kind? | enum | The type of the list. Each type supports specific list items (IP addresses, ASNs, hostnames or redirects). |
| name? | string | An informative name for the list. Use this name in filter and rule expressions. |
| 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 Lists
fn get(id: string)
Get a Lists
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Lists |
fn lookup(allowMissing?: boolean)
Look up an existing Lists 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 Lists by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Lists to import |
fn update(identifier?: string)
Update Lists attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Lists by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Lists
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Lists |
fn sync(identifier?: string)
Sync Lists state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Lists by id (e.g. one discovered by list) |
Resources
state(infinite)— Lists resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: lists
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: lists
2026.09.29.1
- Updated: lists
2026.07.21.1
- Updated: lists
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: lists
2026.05.29.1
- Updated: lists
2026.05.22.1
- Added: lists
05Stats
A
100 / 100
Downloads
25
Archive size
11.7 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