tsigs

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

Overview

Name	tsigs
Type	Resource
Id	cloudflare.dns.tsigs

Fields

The following fields are returned by SELECT queries:

get

TSIG Details response.

Name	Datatype	Description
id	string	(example: 69cd1e104af3e6ed3cb344f263fd0d5a)
name	string	TSIG key name. (example: tsig.customer.cf.)
algo	string	TSIG algorithm. (example: hmac-sha512.)
secret	string	TSIG secret. (example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c)

list

List TSIGs response.

Name	Datatype	Description
id	string	(example: 69cd1e104af3e6ed3cb344f263fd0d5a)
name	string	TSIG key name. (example: tsig.customer.cf.)
algo	string	TSIG algorithm. (example: hmac-sha512.)
secret	string	TSIG secret. (example: caf79a7804b04337c9c66ccd7bef9190a1e1679b5dd03d8aa10f7ad45e1a9dab92b417896c15d4d007c7c14194538d2a5d0feffdecc5a7f0e1c570cfa700837c)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	tsig_id, account_id		Get TSIG.
list	select	account_id		List TSIGs.
create	insert	account_id, name, secret, algo		Create TSIG.
update	replace	tsig_id, account_id, name, secret, algo		Modify TSIG.
delete	delete	tsig_id, account_id		Delete TSIG.

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

SELECT examples

get

Get TSIG.

SELECT
id,
name,
algo,
secret
FROM cloudflare.dns.tsigs
WHERE tsig_id = '{{ tsig_id }}' -- required
AND account_id = '{{ account_id }}' -- required
;

list

List TSIGs.

SELECT
id,
name,
algo,
secret
FROM cloudflare.dns.tsigs
WHERE account_id = '{{ account_id }}' -- required
;

INSERT examples

create

Create TSIG.

INSERT INTO cloudflare.dns.tsigs (
algo,
name,
secret,
account_id
)
SELECT 
'{{ algo }}' /* required */,
'{{ name }}' /* required */,
'{{ secret }}' /* required */,
'{{ account_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: tsigs
props:
  - name: account_id
    value: "{{ account_id }}"
    description: Required parameter for the tsigs resource.
  - name: algo
    value: "{{ algo }}"
    description: |
      TSIG algorithm.
  - name: name
    value: "{{ name }}"
    description: |
      TSIG key name.
  - name: secret
    value: "{{ secret }}"
    description: |
      TSIG secret.

REPLACE examples

update

Modify TSIG.

REPLACE cloudflare.dns.tsigs
SET 
algo = '{{ algo }}',
name = '{{ name }}',
secret = '{{ secret }}'
WHERE 
tsig_id = '{{ tsig_id }}' --required
AND account_id = '{{ account_id }}' --required
AND name = '{{ name }}' --required
AND secret = '{{ secret }}' --required
AND algo = '{{ algo }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete TSIG.

DELETE FROM cloudflare.dns.tsigs
WHERE tsig_id = '{{ tsig_id }}' --required
AND account_id = '{{ account_id }}' --required
;