Cloudflare/smart Shield
@swamp/cloudflare/smart-shieldv2026.10.23.1
01README
Cloudflare smart-shield infrastructure models
02Release Notes
- Updated: healthchecks
03Behaviors
@swamp/cloudflare/smart-shield/healthchecksv2026.10.23.1healthchecks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| zone_id | string | Cloudflare zone ID |
| address? | string | The hostname or IP address of the origin server to run health checks on. |
| check_regions? | array | A list of regions from which to run health checks. Null means Cloudflare will pick a default region. |
| consecutive_fails? | number | The number of consecutive fails required from a health check before changing the health to unhealthy. |
| consecutive_successes? | number | The number of consecutive successes required from a health check before changing the health to healthy. |
| description? | string | A human-readable description of the health check. |
| http_config? | object | Parameters specific to an HTTP or HTTPS health check. |
| interval? | number | The interval between each health check. Shorter intervals may give quicker notifications if the origin status changes, but will increase load on the origin as we check from multiple locations. |
| name? | string | A short name to identify the health check. Only alphanumeric characters, hyphens and underscores are allowed. |
| retries? | number | The number of retries to attempt in case of a timeout before marking the origin as unhealthy. Retries are attempted immediately. |
| suspended? | boolean | If suspended, no health checks are sent to the origin. |
| tcp_config? | object | Parameters specific to TCP health check. |
| timeout? | number | The timeout (in seconds) before marking the health check as failed. |
| type? | string | The protocol to use for the health check. Currently supported protocols are 'HTTP', 'HTTPS' and 'TCP'. |
| 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 Healthchecks
fn get(id: string)
Get a Healthchecks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Healthchecks |
fn lookup(allowMissing?: boolean)
Look up an existing Healthchecks 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 Healthchecks by ID into state for management
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Healthchecks to import |
fn update(identifier?: string)
Update Healthchecks attributes
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Healthchecks by id (e.g. one discovered by list) |
fn delete(id: string)
Delete the Healthchecks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Healthchecks |
fn sync(identifier?: string)
Sync Healthchecks state from Cloudflare
| Argument | Type | Description |
|---|---|---|
| identifier? | string | Target a specific Healthchecks by id (e.g. one discovered by list) |
Resources
state(infinite)— Healthchecks resource state
lookupResult(infinite)— Outcome of the most recent lookup
04Previous Versions
2026.10.20.1AGPL-3.0-or-later
- Updated: healthchecks
Modified 1 behaviors
2026.10.16.1AGPL-3.0-or-later(was none)
2026.10.13.1
- Updated: healthchecks
2026.09.29.1
- Updated: healthchecks
2026.07.21.1
- Updated: healthchecks
2026.07.18.2
Modified 1 behaviors
2026.06.08.2
- Updated: healthchecks
2026.05.29.1
- Updated: healthchecks
2026.05.22.1
- Added: healthchecks
05Stats
A
100 / 100
Downloads
25
Archive size
13.8 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