outgoing

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

Overview

Name	outgoing
Type	Resource
Id	cloudflare.dns.outgoing

Fields

The following fields are returned by SELECT queries:

list

Primary Zone Configuration Details response.

Name	Datatype	Description
id	string	(example: 269d8f4853475ca241c4e730be286b20)
name	string	Zone name. (example: www.example.com.)
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)
last_transferred_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 primary zone configuration for outgoing zone transfers.
update	replace	zone_id, name, peers		Update primary zone configuration for outgoing zone transfers.
delete	delete	zone_id		Delete primary zone configuration for outgoing zone transfers.
disable	exec	zone_id		Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.
enable	exec	zone_id		Enable outgoing zone transfers for primary zone.
force_notify	exec	zone_id		Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.

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 primary zone configuration for outgoing zone transfers.

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

REPLACE examples

update

Update primary zone configuration for outgoing zone transfers.

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

DELETE examples

delete

Delete primary zone configuration for outgoing zone transfers.

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

Lifecycle Methods

disable

Disable outgoing zone transfers for primary zone and clears IXFR backlog of primary zone.

EXEC cloudflare.dns.outgoing.disable 
@zone_id='{{ zone_id }}' --required
;

enable

Enable outgoing zone transfers for primary zone.

EXEC cloudflare.dns.outgoing.enable 
@zone_id='{{ zone_id }}' --required
;

force_notify

Notifies the secondary nameserver(s) and clears IXFR backlog of primary zone.

EXEC cloudflare.dns.outgoing.force_notify 
@zone_id='{{ zone_id }}' --required
;