tags

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

Overview

Name	tags
Type	Resource
Id	cloudflare.zero_trust.tags

Fields

The following fields are returned by SELECT queries:

get

Get a tag response

Name	Datatype	Description
name	string	The name of the tag (example: engineers)
app_count	integer	The number of applications that have this tag
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
updated_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)

list

List tags response

Name	Datatype	Description
name	string	The name of the tag (example: engineers)
app_count	integer	The number of applications that have this tag
created_at	string (date-time)	(example: 2014-01-01T05:20:00.12345Z)
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	account_id, tag_name		Get a tag
list	select	account_id	page, per_page	List tags
create	insert	account_id		Create a tag
update	replace	account_id, tag_name, name		Update a tag
delete	delete	account_id, tag_name		Delete a tag

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.
tag_name	string
page	integer
per_page	integer

SELECT examples

get

Get a tag

SELECT
name,
app_count,
created_at,
updated_at
FROM cloudflare.zero_trust.tags
WHERE account_id = '{{ account_id }}' -- required
AND tag_name = '{{ tag_name }}' -- required
;

list

List tags

SELECT
name,
app_count,
created_at,
updated_at
FROM cloudflare.zero_trust.tags
WHERE account_id = '{{ account_id }}' -- required
AND page = '{{ page }}'
AND per_page = '{{ per_page }}'
;

INSERT examples

create

Create a tag

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

Manifest

# Description fields are for documentation purposes
- name: tags
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the tags resource.
  - name: name
    value: "{{ name }}"
    description: |
      The name of the tag

REPLACE examples

update

Update a tag

REPLACE cloudflare.zero_trust.tags
SET 
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND tag_name = '{{ tag_name }}' --required
AND name = '{{ name }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete a tag

DELETE FROM cloudflare.zero_trust.tags
WHERE account_id = '{{ account_id }}' --required
AND tag_name = '{{ tag_name }}' --required
;