Cloudflare/dlp
@swamp/cloudflare/dlpv2026.10.02.1
01README
Cloudflare dlp infrastructure models
02Release Notes
- Updated: custom
- Updated: predefined
03Models
@swamp/cloudflare/dlp/customv2026.10.02.1custom.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| ai_context_enabled? | boolean | |
| allowed_match_count? | number | Related DLP policies will trigger when the match count exceeds the number set. |
| confidence_threshold? | string | |
| context_awareness? | object | Scan the context of predefined entries to only return matches surrounded by keywords. |
| data_classes? | array | Data class IDs to associate with the profile. |
| data_tags? | array | Data tag IDs to associate with the profile. |
| description? | string | The description of the profile. |
| entries? | array | |
| name? | string | |
| ocr_enabled? | boolean | |
| sensitivity_levels? | array | Sensitivity levels to associate with the profile. |
| shared_entries? | array | Entries from other profiles (e.g. pre-defined Cloudflare profiles, or your Microsoft Information Protection profiles). |
| 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 Custom
fn get(id: string)
Get a Custom
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom |
fn lookup()
Look up an existing Custom by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Custom by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom to import |
fn update(identifier?: string)
Update Custom attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Custom
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom |
fn sync(identifier?: string)
Sync Custom state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom by id (e.g. one discovered by list) |
Resources
state(infinite)— Custom resource state
@swamp/cloudflare/dlp/custom-prompt-topicsv2026.09.29.2custom_prompt_topics.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | |
| enabled? | boolean | |
| name? | string | |
| topic? | string | |
| profile_id? | string | |
| 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 Custom Prompt Topics
fn get(id: string)
Get a Custom Prompt Topics
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Prompt Topics |
fn lookup()
Look up an existing Custom Prompt Topics by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Custom Prompt Topics by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Prompt Topics to import |
fn update(identifier?: string)
Update Custom Prompt Topics attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom Prompt Topics by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Custom Prompt Topics
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Custom Prompt Topics |
fn sync(identifier?: string)
Sync Custom Prompt Topics state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Custom Prompt Topics by id (e.g. one discovered by list) |
Resources
state(infinite)— Custom Prompt Topics resource state
@swamp/cloudflare/dlp/data-classesv2026.09.29.2data_classes.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| data_tags? | array | |
| description? | string | |
| expression? | string | |
| name? | string | |
| sensitivity_levels? | array | |
| 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 Data Classes
fn get(id: string)
Get a Data Classes
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Classes |
fn lookup()
Look up an existing Data Classes by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Data Classes by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Classes to import |
fn update(identifier?: string)
Update Data Classes attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Data Classes by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Data Classes
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Classes |
fn sync(identifier?: string)
Sync Data Classes state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Data Classes by id (e.g. one discovered by list) |
Resources
state(infinite)— Data Classes resource state
@swamp/cloudflare/dlp/data-tag-categoriesv2026.09.29.2data_tag_categories.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | |
| name? | string | |
| tags? | array | Tags to create with the category. Mutually exclusive with `template_id`. |
| template_id? | string | |
| 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 Data Tag Categories
fn get(id: string)
Get a Data Tag Categories
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Tag Categories |
fn lookup()
Look up an existing Data Tag Categories by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Data Tag Categories by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Tag Categories to import |
fn update(identifier?: string)
Update Data Tag Categories attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Data Tag Categories by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Data Tag Categories
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Data Tag Categories |
fn sync(identifier?: string)
Sync Data Tag Categories state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Data Tag Categories by id (e.g. one discovered by list) |
Resources
state(infinite)— Data Tag Categories resource state
@swamp/cloudflare/dlp/datasetsv2026.09.29.2datasets.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| case_sensitive? | boolean | Only applies to custom word lists.\nDetermines if the words should be matched in a case-sensitive manner\nCannot be set to false if `secret` is true or undefined |
| description? | string | The description of the dataset. |
| name? | string | |
| encoding_version? | number | Dataset encoding version\n\nNon-secret custom word lists with no header are always version 1.\nSecret EDM lists with no header are version 1.\nMulticolumn CSV with headers are version 2.\nOmitting this field provides the default value 0, which is interpreted\nthe same as 1. |
| secret? | boolean | Generate a secret dataset.\n\nIf true, the response will include a secret to use with the EDM encoder.\nIf false, the response has no secret and the dataset is uploaded in plaintext. |
| 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 Datasets
fn get(id: string)
Get a Datasets
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Datasets |
fn lookup()
Look up an existing Datasets by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Datasets by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Datasets to import |
fn update(identifier?: string)
Update Datasets attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Datasets by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Datasets
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Datasets |
fn sync(identifier?: string)
Sync Datasets state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Datasets by id (e.g. one discovered by list) |
Resources
state(infinite)— Datasets resource state
@swamp/cloudflare/dlp/document-fingerprintsv2026.09.29.2document_fingerprints.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | |
| match_percent? | number | |
| name? | string | |
| 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 Document Fingerprints
fn get(id: string)
Get a Document Fingerprints
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Document Fingerprints |
fn lookup()
Look up an existing Document Fingerprints by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Document Fingerprints by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Document Fingerprints to import |
fn update(identifier?: string)
Update Document Fingerprints attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Document Fingerprints by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Document Fingerprints
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Document Fingerprints |
fn sync(identifier?: string)
Sync Document Fingerprints state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Document Fingerprints by id (e.g. one discovered by list) |
Resources
state(infinite)— Document Fingerprints resource state
@swamp/cloudflare/dlp/entriesv2026.09.29.2entries.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| enabled? | boolean | |
| description? | string | |
| name? | string | |
| pattern? | object | |
| profile_id? | string | |
| 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 Entries
fn get(id: string)
Get a Entries
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Entries |
fn lookup()
Look up an existing Entries by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Entries by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Entries to import |
fn update(identifier?: string)
Update Entries attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Entries by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Entries
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Entries |
fn sync(identifier?: string)
Sync Entries state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Entries by id (e.g. one discovered by list) |
Resources
state(infinite)— Entries resource state
@swamp/cloudflare/dlp/predefinedv2026.10.02.1predefined.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | Instance name for this resource (used as the unique identifier in the factory pattern) |
| ai_context_enabled? | boolean | |
| allowed_match_count? | number | |
| confidence_threshold? | string | |
| context_awareness? | object | Scan the context of predefined entries to only return matches surrounded by keywords. |
| entries? | array | |
| ocr_enabled? | boolean | |
| profile_id? | string | |
| 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 Predefined
fn get(id: string)
Get a Predefined
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Predefined |
fn lookup()
Look up an existing Predefined by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Predefined by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Predefined to import |
fn update(identifier?: string)
Update Predefined attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Predefined by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Predefined
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Predefined |
fn sync(identifier?: string)
Sync Predefined state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Predefined by id (e.g. one discovered by list) |
Resources
state(infinite)— Predefined resource state
@swamp/cloudflare/dlp/rulesv2026.09.29.2rules.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| action? | object | |
| conditions? | array | Triggered if all conditions match. |
| description? | string | |
| enabled? | boolean | |
| name? | string | |
| 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()
Look up an existing Rules by matching global argument values and import it into state
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
@swamp/cloudflare/dlp/sensitivity-groupsv2026.09.29.2sensitivity_groups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | |
| levels? | array | Levels to create with the group. Mutually exclusive with `template_id`. |
| name? | string | |
| template_id? | string | |
| 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 Sensitivity Groups
fn get(id: string)
Get a Sensitivity Groups
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sensitivity Groups |
fn lookup()
Look up an existing Sensitivity Groups by matching global argument values and import it into state
fn adopt(id: string)
Import an existing Sensitivity Groups by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sensitivity Groups to import |
fn update(identifier?: string)
Update Sensitivity Groups attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Sensitivity Groups by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Sensitivity Groups
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Sensitivity Groups |
fn sync(identifier?: string)
Sync Sensitivity Groups state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Sensitivity Groups by id (e.g. one discovered by list) |
Resources
state(infinite)— Sensitivity Groups resource state
04Previous Versions
2026.09.29.2
- Updated: custom_prompt_topics
- Updated: data_classes
- Updated: data_tag_categories
- Updated: datasets
- Updated: document_fingerprints
- Updated: rules
- Updated: entries
- Updated: custom
- Updated: sensitivity_groups
2026.09.29.1
- Updated: custom_prompt_topics
- Updated: data_classes
- Updated: data_tag_categories
- Updated: datasets
- Updated: document_fingerprints
- Updated: rules
- Updated: entries
- Updated: custom
- Updated: predefined
- Updated: sensitivity_groups
2026.09.24.1
- Updated: custom
- Updated: predefined
2026.08.25.2
- Updated: custom_prompt_topics
- Added: data_classes
- Added: data_tag_categories
- Updated: custom
- Updated: predefined
- Added: sensitivity_groups
Added 3 models
2026.08.25.1
- Updated: custom_prompt_topics
- Updated: custom
- Updated: predefined
Removed 3 models
2026.08.11.1
- Updated: custom
- Updated: predefined
2026.07.21.1
- Updated: custom_prompt_topics
- Updated: data_classes
- Updated: data_tag_categories
- Updated: datasets
- Updated: document_fingerprints
- Updated: rules
- Updated: entries
- Updated: custom
- Updated: predefined
- Updated: sensitivity_groups
2026.07.18.2
Modified 10 models
2026.06.24.1
- Added: data_classes
- Added: data_tag_categories
- Added: sensitivity_groups
Added 10, removed 1 models
2026.06.08.2
- Updated: custom_prompt_topics
- Updated: datasets
- Updated: document_fingerprints
- Updated: rules
- Updated: entries
- Updated: custom
- Updated: predefined
2026.05.29.1
- Updated: custom_prompt_topics
- Updated: datasets
- Updated: document_fingerprints
- Updated: rules
- Updated: entries
- Updated: custom
- Updated: predefined
2026.05.22.1
- Added: custom_prompt_topics
- Added: datasets
- Added: document_fingerprints
- Added: rules
- Added: entries
- Added: custom
- Added: predefined
05Stats
A
100 / 100
Downloads
27
Archive size
28.6 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
- Has description1/1earned
- Platform support declared (or universal)2/2earned
- License declared1/1earned
- Verified public repository2/2earned
06Platforms
07Labels