templates

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

Overview

Name	templates
Type	Resource
Id	cloudflare.cloudforce_one.templates

Fields

The following fields are returned by SELECT queries:

get

Template retrieved successfully

Name	Datatype	Description
id	string
name	string
body	string
category	string
createdAt	string
description	string
source	string	(system, user)
updatedAt	string

list

Templates listed successfully

Name	Datatype	Description
id	string
name	string
category	string
createdAt	string
description	string
source	string	(system, user)
updatedAt	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	account_id, template_id		Get a specific takedown letter template by ID
list	select	account_id		List all available takedown letter templates (system templates and user-defined templates)
post_letter_template_create	insert	account_id, name, category, body		Create a new user-defined takedown letter template
put_letter_template_update	replace	account_id, template_id		Update a user-defined takedown letter template. System templates cannot be modified.
delete_letter_template_delete	delete	account_id, template_id		Delete a user-defined takedown letter template. System templates cannot be deleted.

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

SELECT examples

get

Get a specific takedown letter template by ID

SELECT
id,
name,
body,
category,
createdAt,
description,
source,
updatedAt
FROM cloudflare.cloudforce_one.templates
WHERE account_id = '{{ account_id }}' -- required
AND template_id = '{{ template_id }}' -- required
;

list

List all available takedown letter templates (system templates and user-defined templates)

SELECT
id,
name,
category,
createdAt,
description,
source,
updatedAt
FROM cloudflare.cloudforce_one.templates
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

post_letter_template_create

Create a new user-defined takedown letter template

INSERT INTO cloudflare.cloudforce_one.templates (
body,
category,
description,
name,
account_id
)
SELECT 
'{{ body }}' /* required */,
'{{ category }}' /* required */,
'{{ description }}',
'{{ name }}' /* required */,
'{{ account_id }}'
RETURNING
id,
name,
body,
category,
createdAt,
description,
source,
updatedAt
;

Manifest

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

REPLACE examples

put_letter_template_update

Update a user-defined takedown letter template. System templates cannot be modified.

REPLACE cloudflare.cloudforce_one.templates
SET 
body = '{{ body }}',
category = '{{ category }}',
description = '{{ description }}',
name = '{{ name }}'
WHERE 
account_id = '{{ account_id }}' --required
AND template_id = '{{ template_id }}' --required
RETURNING
id,
name,
body,
category,
createdAt,
description,
source,
updatedAt;

DELETE examples

delete_letter_template_delete

Delete a user-defined takedown letter template. System templates cannot be deleted.

DELETE FROM cloudflare.cloudforce_one.templates
WHERE account_id = '{{ account_id }}' --required
AND template_id = '{{ template_id }}' --required
;