Cloudflare/page Rules
@swamp/cloudflare/page-rulesv2026.10.23.1
01README
Cloudflare page-rules infrastructure models
02Release Notes
- Updated: pagerules
03Behaviors
@swamp/cloudflare/page-rules/pagerulesv2026.10.23.1pagerules.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| zone_id | string | Cloudflare zone ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| actions? | array | The set of actions to perform if the targets of this rule match the\nrequest. Actions can redirect to another URL or override settings, but\nnot both.\n |
| priority? | number | The priority of the rule, used to define which Page Rule is processed\nover another. A higher number indicates a higher priority. For example,\nif you have a catch-all Page Rule (rule A: `/images/*`) but want a more\nspecific Page Rule to take precedence (rule B: `/images/special/*`),\nspecify a higher priority for rule B so it overrides rule A.\n |
| status? | enum | The status of the Page Rule. |
| targets? | array | The rule targets to evaluate on each request. |
| 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 Pagerules
fn get(id: string)
Get a Pagerules
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Pagerules |
fn lookup(allowMissing?: boolean)
Look up an existing Pagerules 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 Pagerules by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Pagerules to import |
fn update(identifier?: string)
Update Pagerules attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Pagerules by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Pagerules
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Pagerules |
fn sync(identifier?: string)
Sync Pagerules state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Pagerules by id (e.g. one discovered by list) |
Resources
state(infinite)— Pagerules resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: pagerules
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: pagerules
2026.09.29.1
- Updated: pagerules
2026.08.11.1
- Updated: pagerules
2026.07.21.1
- Updated: pagerules
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: pagerules
2026.05.29.1
- Updated: pagerules
2026.05.22.1
- Added: pagerules
05Stats
A
100 / 100
Downloads
25
Archive size
13.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