Cloudflare/urlscanner
@swamp/cloudflare/urlscannerv2026.10.23.1
01README
Cloudflare urlscanner infrastructure models
02Release Notes
- Updated: scan
03Behaviors
@swamp/cloudflare/urlscanner/scanv2026.10.23.1scan.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) |
| country? | enum | Country to geo egress from |
| customHeaders? | record | Set custom headers. |
| screenshotsResolutions? | array | Take multiple screenshots targeting different device types. |
| url? | string | |
| visibility? | enum | The option `Public` means it will be included in listings like recent scans and search results. `Unlisted` means it will not be included in the aforementioned listings, users will need to have the scan's ID to access it. A a scan will be automatically marked as unlisted if it fails, if it contains potential PII or other sensitive material. |
| 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 Scan
fn get(id: string)
Get a Scan
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Scan |
fn lookup(allowMissing?: boolean)
Look up an existing Scan 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 Scan by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Scan to import |
fn sync(identifier?: string)
Sync Scan state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Scan by id (e.g. one discovered by list) |
Resources
state(infinite)— Scan resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: scan
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: scan
2026.09.29.1
- Updated: scan
2026.07.21.1
- Updated: scan
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: scan
2026.05.29.1
- Updated: scan
2026.05.22.1
- Added: scan
05Stats
A
100 / 100
Downloads
25
Archive size
15.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
- 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