gateway

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

Overview

Name	gateway
Type	Resource
Id	cloudflare.zero_trust.gateway

Fields

The following fields are returned by SELECT queries:

list

Zero Trust account information response.

Name	Datatype	Description
id	string	Specify the Cloudflare account ID. (example: 699d98642c564d2e855e9661899b7252)
provider_name	string	Specify the provider name (usually Cloudflare). (example: Cloudflare)
gateway_tag	string	Specify the gateway internal ID. (example: f174e90afafe4643bbbc4a0ed4fc8415)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	account_id		Retrieve information about the current Zero Trust account.
create	insert	account_id		Create a Zero Trust account for an existing Cloudflare account.
update_configuration	exec	account_id		Update (PATCH) a single subcollection of settings such as antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning, or certificate without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration.

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.

SELECT examples

list

Retrieve information about the current Zero Trust account.

SELECT
id,
provider_name,
gateway_tag
FROM cloudflare.zero_trust.gateway
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create a Zero Trust account for an existing Cloudflare account.

INSERT INTO cloudflare.zero_trust.gateway (
account_id
)
SELECT 
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: gateway
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the gateway resource.

Lifecycle Methods

update_configuration

Update (PATCH) a single subcollection of settings such as antivirus, tls_decrypt, activity_log, block_page, browser_isolation, fips, body_scanning, or certificate without updating the entire configuration object. This endpoint returns an error if any settings collection lacks proper configuration.

EXEC cloudflare.zero_trust.gateway.update_configuration 
@account_id='{{ account_id }}' --required 
@@json=
'{
"settings": "{{ settings }}"
}'
;