settings

Creates, updates, deletes, gets or lists a settings resource.

Overview

Name	settings
Type	Resource
Id	cloudflare.zero_trust.settings

Fields

The following fields are returned by SELECT queries:

list

List mTLS hostname settings response

Name	Datatype	Description
china_network	boolean	Request client certificates for this hostname in China. Can only be set to true if this zone is china network enabled.
client_certificate_forwarding	boolean	Client Certificate Forwarding is a feature that takes the client cert provided by the eyeball to the edge, and forwards it to the origin as a HTTP header to allow logging on the origin.
hostname	string	The hostname that these settings apply to. (example: admin.example.com)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		List all mTLS hostname settings for this account or zone.
edit_by_account	update	app_id, account_id		Updates Access application settings.
edit_by_zone	update	app_id, zone_id		Updates Access application settings.
update_by_account	replace	app_id, account_id		Updates Access application settings.
update_by_zone	replace	app_id, zone_id		Updates Access application settings.
put_accounts_account_id_access_certificates_settings	replace	account_id, settings		Updates an mTLS certificate's hostname settings.
put_zones_zone_id_access_certificates_settings	replace	zone_id, settings		Updates an mTLS certificate's hostname settings.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
account_id	string	The Cloudflare account ID.
app_id	string	The Access application ID.
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

List all mTLS hostname settings for this account or zone.

SELECT
china_network,
client_certificate_forwarding,
hostname
FROM cloudflare.zero_trust.settings
WHERE zone_id = '{{ zone_id }}' -- required
;

UPDATE examples

edit_by_account

Updates Access application settings.

UPDATE cloudflare.zero_trust.settings
SET 
allow_iframe = {{ allow_iframe }},
skip_interstitial = {{ skip_interstitial }}
WHERE 
app_id = '{{ app_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

edit_by_zone

Updates Access application settings.

UPDATE cloudflare.zero_trust.settings
SET 
allow_iframe = {{ allow_iframe }},
skip_interstitial = {{ skip_interstitial }}
WHERE 
app_id = '{{ app_id }}' --required
AND zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update_by_account

Updates Access application settings.

REPLACE cloudflare.zero_trust.settings
SET 
allow_iframe = {{ allow_iframe }},
skip_interstitial = {{ skip_interstitial }}
WHERE 
app_id = '{{ app_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

update_by_zone

Updates Access application settings.

REPLACE cloudflare.zero_trust.settings
SET 
allow_iframe = {{ allow_iframe }},
skip_interstitial = {{ skip_interstitial }}
WHERE 
app_id = '{{ app_id }}' --required
AND zone_id = '{{ zone_id }}' --required
RETURNING
errors,
messages,
result,
success;

put_accounts_account_id_access_certificates_settings

Updates an mTLS certificate's hostname settings.

REPLACE cloudflare.zero_trust.settings
SET 
settings = '{{ settings }}'
WHERE 
account_id = '{{ account_id }}' --required
AND settings = '{{ settings }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;

put_zones_zone_id_access_certificates_settings

Updates an mTLS certificate's hostname settings.

REPLACE cloudflare.zero_trust.settings
SET 
settings = '{{ settings }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND settings = '{{ settings }}' --required
RETURNING
errors,
messages,
result,
result_info,
success;