lists

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

Overview

Name	lists
Type	Resource
Id	cloudflare.zero_trust.lists

Fields

The following fields are returned by SELECT queries:

get

Get Zero Trust list details response.

Name	Datatype	Description
id	string	Identify the API resource with a UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	Specify the list name. (example: Admin Serial Numbers)
count	number	Indicate the number of items in the list. (x-stainless-terraform-configurability: computed)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
description	string	Provide the list description. (example: The serial numbers for administrators, x-stainless-terraform-configurability: computed_optional)
items	array	Provide the list items. (x-stainless-collection-type: set)
type	string	Specify the list type. (SERIAL, URL, DOMAIN, EMAIL, IP, CATEGORY, LOCATION, DEVICE, AAGUID) (example: SERIAL)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

list

List Zero Trust lists response.

Name	Datatype	Description
id	string	Identify the API resource with a UUID. (example: f174e90a-fafe-4643-bbbc-4a0ed4fc8415)
name	string	Specify the list name. (example: Admin Serial Numbers)
count	number	Indicate the number of items in the list. (x-stainless-terraform-configurability: computed)
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
description	string	Provide the list description. (example: The serial numbers for administrators, x-stainless-terraform-configurability: computed_optional)
items	array	Provide the list items. (x-stainless-collection-type: set)
type	string	Specify the list type. (SERIAL, URL, DOMAIN, EMAIL, IP, CATEGORY, LOCATION, DEVICE, AAGUID) (example: SERIAL)
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	list_id, account_id		Fetch a single Zero Trust list.
list	select	account_id	type	Fetch all Zero Trust lists for an account.
create	insert	account_id, name, type		Creates a new Zero Trust list.
edit	update	list_id, account_id		Appends or removes an item from a configured Zero Trust list.
update	replace	list_id, account_id, name		Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list.
delete	delete	list_id, account_id		Deletes a Zero Trust list.

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.
list_id	string
type	string

SELECT examples

get

Fetch a single Zero Trust list.

SELECT
id,
name,
count,
created_at,
description,
items,
type,
updated_at
FROM cloudflare.zero_trust.lists
WHERE list_id = '{{ list_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

Fetch all Zero Trust lists for an account.

SELECT
id,
name,
count,
created_at,
description,
items,
type,
updated_at
FROM cloudflare.zero_trust.lists
WHERE account_id = '{{ account_id }}' -- required
AND type = '{{ type }}'
;

INSERT examples

create

Creates a new Zero Trust list.

INSERT INTO cloudflare.zero_trust.lists (
description,
items,
name,
type,
account_id
)
SELECT 
'{{ description }}',
'{{ items }}',
'{{ name }}' /* required */,
'{{ type }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: lists
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the lists resource.
  - name: description
    value: "{{ description }}"
    description: |
      Provide the list description.
  - name: items
    description: |
      Add items to the list.
    value:
      - description: "{{ description }}"
        value: "{{ value }}"
  - name: name
    value: "{{ name }}"
    description: |
      Specify the list name.
  - name: type
    value: "{{ type }}"
    description: |
      Specify the list type.
    valid_values: ['SERIAL', 'URL', 'DOMAIN', 'EMAIL', 'IP', 'CATEGORY', 'LOCATION', 'DEVICE', 'AAGUID']

UPDATE examples

edit

Appends or removes an item from a configured Zero Trust list.

UPDATE cloudflare.zero_trust.lists
SET 
append = '{{ append }}',
remove = '{{ remove }}'
WHERE 
list_id = '{{ list_id }}' --required
AND account_id = '{{ account_id }}' --required
RETURNING
errors,
messages,
result,
success;

REPLACE examples

update

Updates a configured Zero Trust list. Skips updating list items if not included in the payload. A non empty list items will overwrite the existing list.

REPLACE cloudflare.zero_trust.lists
SET 
description = '{{ description }}',
items = '{{ items }}',
name = '{{ name }}'
WHERE 
list_id = '{{ list_id }}' --required
AND account_id = '{{ account_id }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Deletes a Zero Trust list.

DELETE FROM cloudflare.zero_trust.lists
WHERE list_id = '{{ list_id }}' --required
AND account_id = '{{ account_id }}' --required
;