Skip to main content

settings

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

Overview

Namesettings
TypeResource
Idcloudflare.origin_tls_client_auth.settings

Fields

The following fields are returned by SELECT queries:

Get Enablement Setting for Zone response

NameDatatypeDescription
enabledbooleanIndicates whether zone-level authenticated origin pulls is enabled.

Methods

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
listselectzone_idGet whether zone-level authenticated origin pulls is enabled or not. It is false by default.
updatereplacezone_id, enabledEnable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

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.

NameDatatypeDescription
zone_idstringThe Cloudflare zone ID.

SELECT examples

Get whether zone-level authenticated origin pulls is enabled or not. It is false by default.

SELECT
enabled
FROM cloudflare.origin_tls_client_auth.settings
WHERE zone_id = '{{ zone_id }}' -- required
;

REPLACE examples

Enable or disable zone-level authenticated origin pulls. 'enabled' should be set true either before/after the certificate is uploaded to see the certificate in use.

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