settings
Creates, updates, deletes, gets or lists a settings resource.
Overview
| Name | settings |
| Type | Resource |
| Id | cloudflare.origin_tls_client_auth.settings |
Fields
The following fields are returned by SELECT queries:
- list
Get Enablement Setting for Zone response
| Name | Datatype | Description |
|---|---|---|
enabled | boolean | Indicates whether zone-level authenticated origin pulls is enabled. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
list | select | zone_id | Get whether zone-level authenticated origin pulls is enabled or not. It is false by default. | |
update | replace | zone_id, enabled | 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. |
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 |
|---|---|---|
zone_id | string | The Cloudflare zone ID. |
SELECT examples
- list
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
- update
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;