site_dns

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

Overview

Name	site_dns
Type	Resource
Id	netlify.sites.site_dns

Fields

The following fields are returned by SELECT queries:

get

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	site_id
configure	exec	site_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
site_id	string

SELECT examples

get

OK

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.sites.site_dns
WHERE site_id = '{{ site_id }}' -- required
;

Lifecycle Methods

configure

OK

EXEC netlify.sites.site_dns.configure 
@site_id='{{ site_id }}' --required
;