Cloudflare/devices
@swamp/cloudflare/devicesv2026.06.24.1
01README
Cloudflare devices infrastructure models
02Release Notes
- Updated: policy
03Models
@swamp/cloudflare/devices/deployment-groupsv2026.06.08.1deployment-groups.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| name | string | A user-friendly name for the deployment group. |
| policy_ids? | array | Contains an optional list of policy IDs assigned to a group. |
| version_config | array | Contains at least one version configuration. |
| 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 Deployment-groups
fn get(id: string)
Get a Deployment-groups
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Deployment-groups |
fn update()
Update Deployment-groups attributes
fn delete(id: string)
Delete the Deployment-groups
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Deployment-groups |
fn sync()
Sync Deployment-groups state from Cloudflare
Resources
state(infinite)— Deployment-groups resource state
@swamp/cloudflare/devices/integrationv2026.06.08.1integration.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| config | object | |
| interval | string | The interval between each posture check with the third-party API. Use `m` for minutes (e.g. `5m`) and `h` for hours (e.g. `12h`). |
| name | string | The name of the device posture integration. |
| type | enum | The type of device posture integration. |
| 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 Integration
fn get(id: string)
Get a Integration
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Integration |
fn update()
Update Integration attributes
fn delete(id: string)
Delete the Integration
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Integration |
fn sync()
Sync Integration state from Cloudflare
Resources
state(infinite)— Integration resource state
@swamp/cloudflare/devices/ip-profilesv2026.06.08.1ip-profiles.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | An optional description of the Device IP profile. |
| enabled? | boolean | Whether the Device IP profile will be applied to matching devices. |
| match | string | The wirefilter expression to match registrations. Available values: "identity.name", "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.saml_attributes". |
| name | string | A user-friendly name for the Device IP profile. |
| precedence | number | The precedence of the Device IP profile. Lower values indicate higher precedence. Device IP profile will be evaluated in ascending order of this field. |
| subnet_id | string | The ID of the Subnet. |
| 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 Ip-profiles
fn get(id: string)
Get a Ip-profiles
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Ip-profiles |
fn update()
Update Ip-profiles attributes
fn delete(id: string)
Delete the Ip-profiles
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Ip-profiles |
fn sync()
Sync Ip-profiles state from Cloudflare
Resources
state(infinite)— Ip-profiles resource state
@swamp/cloudflare/devices/networksv2026.06.08.1networks.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| config | object | |
| name | string | The name of the device managed network. This name must be unique. |
| type | enum | The type of device managed network. |
| 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 Networks
fn get(id: string)
Get a Networks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Networks |
fn update()
Update Networks attributes
fn delete(id: string)
Delete the Networks
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Networks |
fn sync()
Sync Networks state from Cloudflare
Resources
state(infinite)— Networks resource state
@swamp/cloudflare/devices/policyv2026.06.24.1policy.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| allow_mode_switch? | boolean | Whether to allow the user to switch WARP between modes. |
| allow_updates? | boolean | Whether to receive update notifications when a new version of the client is available. |
| allowed_to_leave? | boolean | Whether to allow devices to leave the organization. |
| auto_connect? | number | The amount of time in seconds to reconnect after having been disabled. |
| captive_portal? | number | Turn on the captive portal after the specified amount of time. |
| description? | string | A description of the policy. |
| disable_auto_fallback? | boolean | If the `dns_server` field of a fallback domain is not present, the client will fall back to a best guess of the default/system DNS resolvers unless this policy option is set to `true`. |
| dns_search_suffixes? | array | List of DNS search suffixes to apply to clients. Suffixes are evaluated in order. Use an empty array to clear. |
| enabled? | boolean | Whether the policy will be applied to matching devices. |
| exclude? | array | List of routes excluded in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. |
| exclude_office_ips? | boolean | Whether to add Microsoft IPs to Split Tunnel exclusions. |
| global_acceleration? | object | Global Acceleration settings for China. When configured, WARP clients connect to the Global Accelerator addresses instead of the default ones. Please contact your account representative to enable this feature on your account. See https://developers.cloudflare.com/china-network/concepts/global-acceleration/. |
| include? | array | List of routes included in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. |
| lan_allow_minutes? | number | The amount of time in minutes a user is allowed access to their LAN. A value of 0 will allow LAN access until the next WARP reconnection, such as a reboot or a laptop waking from sleep. Note that this field is omitted from the response if null or unset. |
| lan_allow_subnet_size? | number | The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset. |
| match | string | The wirefilter expression to match devices. Available values: "identity.email", "identity.groups.id", "identity.groups.name", "identity.groups.email", "identity.service_token_uuid", "identity.saml_attributes", "network", "os.name", "os.version". |
| name | string | The name of the device settings profile. |
| precedence | number | The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. |
| register_interface_ip_with_dns? | boolean | Determines if the operating system will register WARP's local interface IP with your on-premises DNS server. |
| sccm_vpn_boundary_support? | boolean | Determines whether the WARP client indicates to SCCM that it is inside a VPN boundary. (Windows only). |
| service_mode_v2? | object | |
| support_url? | string | The URL to launch when the Send Feedback button is clicked. |
| switch_locked? | boolean | Whether to allow the user to turn off the WARP switch and disconnect the client. |
| tunnel_protocol? | string | Determines which tunnel protocol to use. |
| virtual_networks? | object | Virtual network access settings for the device. |
| 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 Policy
fn get(id: string)
Get a Policy
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Policy |
fn update()
Update Policy attributes
fn delete(id: string)
Delete the Policy
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Policy |
fn sync()
Sync Policy state from Cloudflare
Resources
state(infinite)— Policy resource state
@swamp/cloudflare/devices/posturev2026.06.08.1posture.ts
Global Arguments
| Argument | Type | Description |
|---|---|---|
| account_id | string | Cloudflare account ID |
| description? | string | The description of the device posture rule. |
| expiration? | string | Sets the expiration time for a posture check result. If empty, the result remains valid until it is overwritten by new data from the WARP client. |
| input? | object | |
| match? | array | The conditions that the client must match to run the rule. |
| name | string | The name of the device posture rule. |
| schedule? | string | Polling frequency for the WARP client posture check. Default: `5m` (poll every five minutes). Minimum: `1m`. |
| type | enum | The type of device posture rule. |
| 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 Posture
fn get(id: string)
Get a Posture
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Posture |
fn update()
Update Posture attributes
fn delete(id: string)
Delete the Posture
| Argument | Type | Description |
|---|---|---|
| id | string | The ID of the Posture |
fn sync()
Sync Posture state from Cloudflare
Resources
state(infinite)— Posture resource state
04Previous Versions
2026.06.08.2Jun 8, 2026
- Updated: deployment-groups
- Updated: ip-profiles
- Updated: networks
- Updated: policy
- Updated: posture
- Updated: integration
2026.05.29.1May 29, 2026
- Updated: deployment-groups
- Updated: ip-profiles
- Updated: networks
- Updated: policy
- Updated: posture
- Updated: integration
2026.05.22.1May 22, 2026
- Added: deployment-groups
- Added: ip-profiles
- Added: networks
- Added: policy
- Added: posture
- Added: integration
05Stats
A
100 / 100
Downloads
0
Archive size
25.4 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