dns_records

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

Overview

Name	dns_records
Type	Resource
Id	netlify.dns.dns_records

Fields

The following fields are returned by SELECT queries:

get

get a single DNS record

Name	Datatype	Description
id	string
dns_zone_id	string
site_id	string
flag	integer
hostname	string
managed	boolean
priority	integer (int64)
tag	string
ttl	integer (int64)
type	string
value	string

list

get all DNS records for a single DNS zone

Name	Datatype	Description
id	string
dns_zone_id	string
site_id	string
flag	integer
hostname	string
managed	boolean
priority	integer (int64)
tag	string
ttl	integer (int64)
type	string
value	string

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	zone_id, dns_record_id
list	select	zone_id
create	insert	zone_id
delete	delete	zone_id, dns_record_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
dns_record_id	string
zone_id	string

SELECT examples

get

get a single DNS record

SELECT
id,
dns_zone_id,
site_id,
flag,
hostname,
managed,
priority,
tag,
ttl,
type,
value
FROM netlify.dns.dns_records
WHERE zone_id = '{{ zone_id }}' -- required
AND dns_record_id = '{{ dns_record_id }}' -- required
;

list

get all DNS records for a single DNS zone

SELECT
id,
dns_zone_id,
site_id,
flag,
hostname,
managed,
priority,
tag,
ttl,
type,
value
FROM netlify.dns.dns_records
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

create

No description available.

INSERT INTO netlify.dns.dns_records (
type,
hostname,
value,
ttl,
priority,
weight,
port,
flag,
tag,
zone_id
)
SELECT 
'{{ type }}',
'{{ hostname }}',
'{{ value }}',
{{ ttl }},
{{ priority }},
{{ weight }},
{{ port }},
{{ flag }},
'{{ tag }}',
'{{ zone_id }}'
RETURNING
id,
dns_zone_id,
site_id,
flag,
hostname,
managed,
priority,
tag,
ttl,
type,
value
;

Manifest

# Description fields are for documentation purposes
- name: dns_records
props:
  - name: zone_id
    value: "{{ zone_id }}"
    description: Required parameter for the dns_records resource.
  - name: type
    value: "{{ type }}"
  - name: hostname
    value: "{{ hostname }}"
  - name: value
    value: "{{ value }}"
  - name: ttl
    value: {{ ttl }}
  - name: priority
    value: {{ priority }}
  - name: weight
    value: {{ weight }}
  - name: port
    value: {{ port }}
  - name: flag
    value: {{ flag }}
  - name: tag
    value: "{{ tag }}"

DELETE examples

delete

No description available.

DELETE FROM netlify.dns.dns_records
WHERE zone_id = '{{ zone_id }}' --required
AND dns_record_id = '{{ dns_record_id }}' --required
;