PATCH /accounts/{account_id}/devices/policy/{policy_id}
Updates a configured device settings profile.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
policy_id |
String | Yes | |
account_id |
Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
allow_mode_switch |
Boolean | No |
Whether to allow the user to switch WARP between modes. |
auto_connect |
Number | No |
The amount of time in seconds to reconnect after having been disabled. |
description |
String | No |
A description of the policy. |
disable_auto_fallback |
Boolean | No |
If the |
register_interface_ip_with_dns |
Boolean | No |
Determines if the operating system will register WARP's local interface IP with your on-premises DNS server. |
allowed_to_leave |
Boolean | No |
Whether to allow devices to leave the organization. |
captive_portal |
Number | No |
Turn on the captive portal after the specified amount of time. |
exclude[] |
Array | No |
List of routes excluded in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. |
switch_locked |
Boolean | No |
Whether to allow the user to turn off the WARP switch and disconnect the client. |
service_mode_v2 |
Object | No | |
service_mode_v2.port |
Number | No |
The port number when used with proxy mode. |
service_mode_v2.mode |
String | No |
The mode to run the WARP client under. |
name |
String | No |
The name of the device settings profile. |
include[] |
Array | No |
List of routes included in the WARP client's tunnel. Both 'exclude' and 'include' cannot be set in the same request. |
exclude_office_ips |
Boolean | No |
Whether to add Microsoft IPs to Split Tunnel exclusions. |
tunnel_protocol |
String | No |
Determines which tunnel protocol to use. |
match |
String | No |
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". |
support_url |
String | No |
The URL to launch when the Send Feedback button is clicked. |
allow_updates |
Boolean | No |
Whether to receive update notifications when a new version of the client is available. |
enabled |
Boolean | No |
Whether the policy will be applied to matching devices. |
precedence |
Number | No |
The precedence of the policy. Lower values indicate higher precedence. Policies will be evaluated in ascending order of this field. |
lan_allow_subnet_size |
Number | No |
The size of the subnet for the local access network. Note that this field is omitted from the response if null or unset. |
lan_allow_minutes |
Number | No |
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. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.