incoming

Creates, updates, deletes, gets or lists an incoming resource.

Overview

Name	incoming
Type	Resource
Id	cloudflare.dns.incoming

Fields

The following fields are returned by SELECT queries:

list

Secondary Zone Configuration Details response.

Name	Datatype	Description
id	string	(example: 269d8f4853475ca241c4e730be286b20)
name	string	Zone name. (example: www.example.com.)
auto_refresh_seconds	number	How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not applicable for primary zones.
checked_time	string	The time for a specific event. (example: 2019-10-24T17:09:42.883908+01:00)
created_time	string	The time for a specific event. (example: 2019-10-24T17:09:42.883908+01:00)
modified_time	string	The time for a specific event. (example: 2019-10-24T17:09:42.883908+01:00)
peers	array	A list of peer tags. (x-stainless-collection-type: set)
soa_serial	number	The serial number of the SOA for the given zone.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	zone_id		Get secondary zone configuration for incoming zone transfers.
create	insert	zone_id, name, peers, auto_refresh_seconds		Create secondary zone configuration for incoming zone transfers.
update	replace	zone_id, name, peers, auto_refresh_seconds		Update secondary zone configuration for incoming zone transfers.
delete	delete	zone_id		Delete secondary zone configuration for incoming zone transfers.

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
zone_id	string	The Cloudflare zone ID.

SELECT examples

list

Get secondary zone configuration for incoming zone transfers.

SELECT
id,
name,
auto_refresh_seconds,
checked_time,
created_time,
modified_time,
peers,
soa_serial
FROM cloudflare.dns.incoming
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

create

Create secondary zone configuration for incoming zone transfers.

INSERT INTO cloudflare.dns.incoming (
auto_refresh_seconds,
name,
peers,
zone_id
)
SELECT 
{{ auto_refresh_seconds }} /* required */,
'{{ name }}' /* required */,
'{{ peers }}' /* required */,
'{{ zone_id }}'
RETURNING
errors,
messages,
result,
success
;

Manifest

# Description fields are for documentation purposes
- name: incoming
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the incoming resource.
  - name: auto_refresh_seconds
    value: {{ auto_refresh_seconds }}
    description: |
      How often should a secondary zone auto refresh regardless of DNS NOTIFY. Not applicable for primary zones.
    default: 86400
  - name: name
    value: "{{ name }}"
    description: |
      Zone name.
  - name: peers
    value:
      - "{{ peers }}"
    description: |
      A list of peer tags.

REPLACE examples

update

Update secondary zone configuration for incoming zone transfers.

REPLACE cloudflare.dns.incoming
SET 
auto_refresh_seconds = {{ auto_refresh_seconds }},
name = '{{ name }}',
peers = '{{ peers }}'
WHERE 
zone_id = '{{ zone_id }}' --required
AND name = '{{ name }}' --required
AND peers = '{{ peers }}' --required
AND auto_refresh_seconds = '{{ auto_refresh_seconds }}' --required
RETURNING
errors,
messages,
result,
success;

DELETE examples

delete

Delete secondary zone configuration for incoming zone transfers.

DELETE FROM cloudflare.dns.incoming
WHERE zone_id = '{{ zone_id }}' --required
;