PUT /accounts/{account_id}/devices/settings

Updates the current device settings for a Zero Trust account.

Servers

Path parameters

Name Type Required Description
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
gateway_proxy_enabled Boolean No

Enable gateway proxy filtering on TCP.

gateway_udp_proxy_enabled Boolean No

Enable gateway proxy filtering on UDP.

external_emergency_signal_fingerprint String No

The SHA256 fingerprint (64 hexadecimal characters) of the HTTPS server certificate for the external_emergency_signal_url. If provided, the WARP client will use this value to verify the server's identity. The device will ignore any response if the server's certificate fingerprint does not exactly match this value.

use_zt_virtual_ip Boolean No

Enable using CGNAT virtual IPv4.

external_emergency_signal_interval String No

The interval at which the WARP client fetches the emergency disconnect signal, formatted as a duration string (e.g., "5m", "2m30s", "1h"). Minimum 30 seconds.

external_emergency_signal_enabled Boolean No

Controls whether the external emergency disconnect feature is enabled.

external_emergency_signal_url String No

The HTTPS URL from which to fetch the emergency disconnect signal. Must use HTTPS and have an IPv4 or IPv6 address as the host.

root_certificate_installation_enabled Boolean No

Enable installation of cloudflare managed root certificate.

disable_for_time Number No

Sets the time limit, in seconds, that a user can use an override code to bypass WARP.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. 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.
  3. Click Test request to test run your request to the API and see the API's response.