dns_zones

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

Overview

Name	dns_zones
Type	Resource
Id	netlify.dns.dns_zones

Fields

The following fields are returned by SELECT queries:

get

get a single DNS zone

Name	Datatype	Description
id	string
name	string
account_id	string
site_id	string
user_id	string
account_name	string
account_slug	string
created_at	string (dateTime)
dedicated	boolean
dns_servers	array
domain	string
errors	array
ipv6_enabled	boolean
records	array
supported_record_types	array
updated_at	string (dateTime)

list

get all DNS zones the user has access to

Name	Datatype	Description
id	string
name	string
account_id	string
site_id	string
user_id	string
account_name	string
account_slug	string
created_at	string (dateTime)
dedicated	boolean
dns_servers	array
domain	string
errors	array
ipv6_enabled	boolean
records	array
supported_record_types	array
updated_at	string (dateTime)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id
list	select		account_slug
create	insert
delete	delete	zone_id
transfer	exec	zone_id, account_id, transfer_account_id, transfer_user_id

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 account of the dns zone
transfer_account_id	string	the account you want to transfer the dns zone to
transfer_user_id	string	the user you want to transfer the dns zone to
zone_id	string
account_slug	string

SELECT examples

get

get a single DNS zone

SELECT
id,
name,
account_id,
site_id,
user_id,
account_name,
account_slug,
created_at,
dedicated,
dns_servers,
domain,
errors,
ipv6_enabled,
records,
supported_record_types,
updated_at
FROM netlify.dns.dns_zones
WHERE zone_id = '{{ zone_id }}' -- required
;

list

get all DNS zones the user has access to

SELECT
id,
name,
account_id,
site_id,
user_id,
account_name,
account_slug,
created_at,
dedicated,
dns_servers,
domain,
errors,
ipv6_enabled,
records,
supported_record_types,
updated_at
FROM netlify.dns.dns_zones
WHERE account_slug = '{{ account_slug }}'
;

INSERT examples

create

No description available.

INSERT INTO netlify.dns.dns_zones (
account_slug,
site_id,
name
)
SELECT 
'{{ account_slug }}',
'{{ site_id }}',
'{{ name }}'
RETURNING
id,
name,
account_id,
site_id,
user_id,
account_name,
account_slug,
created_at,
dedicated,
dns_servers,
domain,
errors,
ipv6_enabled,
records,
supported_record_types,
updated_at
;

Manifest

# Description fields are for documentation purposes
- name: dns_zones
props:
  - name: account_slug
    value: "{{ account_slug }}"
  - name: site_id
    value: "{{ site_id }}"
  - name: name
    value: "{{ name }}"

DELETE examples

delete

No description available.

DELETE FROM netlify.dns.dns_zones
WHERE zone_id = '{{ zone_id }}' --required
;

Lifecycle Methods

transfer

transfer a DNS zone to another account

EXEC netlify.dns.dns_zones.transfer 
@zone_id='{{ zone_id }}' --required, 
@account_id='{{ account_id }}' --required, 
@transfer_account_id='{{ transfer_account_id }}' --required, 
@transfer_user_id='{{ transfer_user_id }}' --required
;