proxy_endpoints

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

Overview

Name	proxy_endpoints
Type	Resource
Id	cloudflare.zero_trust.proxy_endpoints

Fields

The following fields are returned by SELECT queries:

get

Returns a proxy endpoint response.

Name	Datatype	Description
id	string	(example: ed35569b41ce4d1facfe683550f54086)
name	string	Specify the name of the proxy endpoint. (example: Devops team)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
ips	array	Specify the list of CIDRs to restrict ingress connections.
kind	string	The proxy endpoint kind (ip) (example: ip)
subdomain	string	Specify the subdomain to use as the destination in the proxy client. (example: oli3n9zkz5.proxy.cloudflare-gateway.com)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

list

Returns a list of proxy endpoints response.

Name	Datatype	Description
id	string	(example: ed35569b41ce4d1facfe683550f54086)
name	string	Specify the name of the proxy endpoint. (example: Devops team)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
ips	array	Specify the list of CIDRs to restrict ingress connections.
kind	string	The proxy endpoint kind (ip) (example: ip)
subdomain	string	Specify the subdomain to use as the destination in the proxy client. (example: oli3n9zkz5.proxy.cloudflare-gateway.com)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	proxy_endpoint_id, account_id		Get a single Zero Trust Gateway proxy endpoint.
list	select	account_id		List all Zero Trust Gateway proxy endpoints for an account.
create	insert	account_id, name		Create a new Zero Trust Gateway proxy endpoint.
edit	update	proxy_endpoint_id, account_id		Update a configured Zero Trust Gateway proxy endpoint.
delete	delete	proxy_endpoint_id, account_id		Delete a configured Zero Trust Gateway proxy endpoint.

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.
proxy_endpoint_id	string

SELECT examples

get

Get a single Zero Trust Gateway proxy endpoint.

SELECT
id,
name,
created_at,
ips,
kind,
subdomain,
updated_at
FROM cloudflare.zero_trust.proxy_endpoints
WHERE proxy_endpoint_id = '{{ proxy_endpoint_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

List all Zero Trust Gateway proxy endpoints for an account.

SELECT
id,
name,
created_at,
ips,
kind,
subdomain,
updated_at
FROM cloudflare.zero_trust.proxy_endpoints
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create a new Zero Trust Gateway proxy endpoint.

INSERT INTO cloudflare.zero_trust.proxy_endpoints (
kind,
name,
account_id
)
SELECT 
'{{ kind }}',
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: proxy_endpoints
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the proxy_endpoints resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      The proxy endpoint kind.
    valid_values: ['ip', 'identity']
    default: ip
  - name: name
    value: "{{ name }}"
    description: |
      Specify the name of the proxy endpoint.

UPDATE examples

edit

Update a configured Zero Trust Gateway proxy endpoint.

UPDATE cloudflare.zero_trust.proxy_endpoints
SET 
ips = '{{ ips }}',
name = '{{ name }}'
WHERE 
proxy_endpoint_id = '{{ proxy_endpoint_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a configured Zero Trust Gateway proxy endpoint.

DELETE FROM cloudflare.zero_trust.proxy_endpoints
WHERE proxy_endpoint_id = '{{ proxy_endpoint_id }}' --required
AND account_id = '{{ account_id }}' --required
;