sites_dns
Creates, updates, deletes, gets or lists a sites_dns
resource.
Overview
Name | sites_dns |
Type | Resource |
Id | netlify.dns_zone.sites_dns |
Fields
The following fields are returned by SELECT
queries:
- getDNSForSite
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 |
---|---|---|---|---|
getDNSForSite | select | site_id | ||
configureDNSForSite | 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
- getDNSForSite
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.dns_zone.sites_dns
WHERE site_id = '{{ site_id }}' -- required
;
Lifecycle Methods
- configureDNSForSite
OK
EXEC netlify.dns_zone.sites_dns.configureDNSForSite
@site_id='{{ site_id }}' --required
;