dns_zones_dns_records

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

Overview

Name	dns_zones_dns_records
Type	Resource
Id	netlify.dns_zone.dns_zones_dns_records

Fields

The following fields are returned by SELECT queries:

getIndividualDnsRecord

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

getDnsRecords

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
getIndividualDnsRecord	select	zone_id, dns_record_id
getDnsRecords	select	zone_id
createDnsRecord	insert	zone_id
deleteDnsRecord	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

getIndividualDnsRecord

get a single DNS record

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

getDnsRecords

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_zone.dns_zones_dns_records
WHERE zone_id = '{{ zone_id }}' -- required
;

INSERT examples

createDnsRecord

No description available.

INSERT INTO netlify.dns_zone.dns_zones_dns_records (
data__flag,
data__hostname,
data__port,
data__priority,
data__tag,
data__ttl,
data__type,
data__value,
data__weight,
zone_id
)
SELECT 
{{ flag }},
'{{ hostname }}',
{{ port }},
{{ priority }},
'{{ tag }}',
{{ ttl }},
'{{ type }}',
'{{ value }}',
{{ weight }},
'{{ 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_zones_dns_records
  props:
    - name: zone_id
      value: string
      description: Required parameter for the dns_zones_dns_records resource.
    - name: flag
      value: integer
    - name: hostname
      value: string
    - name: port
      value: integer
    - name: priority
      value: integer
    - name: tag
      value: string
    - name: ttl
      value: integer
    - name: type
      value: string
    - name: value
      value: string
    - name: weight
      value: integer

DELETE examples

deleteDnsRecord

No description available.

DELETE FROM netlify.dns_zone.dns_zones_dns_records
WHERE zone_id = '{{ zone_id }}' --required
AND dns_record_id = '{{ dns_record_id }}' --required
;