Retrieving the Data Source
This data source can be retrieved by one of ID or name.Retrieve by ID
To retrieve by ID, fill in only theid field:
Retrieve by Name
To retrieve by name, fill in only thename and parent_id fields:
Zone API Resource which is managed by the ZoneService
Schema
Optional
id(String) Identifier for the resource, unique for its resource type.name(String) Human readable name for the resource.parent_id(String) Identifier of the parent resource to which the resource belongs.
Read-Only
-
created_at(String) : Timestamp indicating when the resource was created. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM -
data(String) : Record data in text format This should be the RDATA part of this Resource Record’s presentation (zonefile) format. E.g.,10 xyz.tuvfor a@ 600 IN MX 10 xyz.tuv.resource record in a zonefile -
deletion_protection(Boolean) : Mark this record as delete-protected Delete-protected records can only be deleted by explicitly callingRecordService/DeleteAPI withforceflag set totrue -
labels(Map of String) : Labels associated with the resource. -
metadata(Attributes) : DNS record metadatametadata.parent_idmust be a DNS zone IDInner value description
Common resource metadata. (see below for nested schema) -
relative_name(String) : Zone-relative name of this record (e.g.,wwwforwww.<parent zone's domain name>) Use@for records in zone apex (that is, records that have the same domain name as the zone itself) To see the resolved absolute domain name, seeRecord.status.effective_fqdn -
resource_version(Number) : Version of the resource for safe concurrent modifications and consistent reads. Positive and monotonically increases on each resource spec change (but not on each change of the resource’s container(s) or status). Service allows zero value or current. -
status(Attributes) : DNS record status, including e.g. its effective FQDN (fully-qualified domain name)Inner value description
DNS record status (see below for nested schema) -
ttl(Number) Record TTL. If absent or negative, will be assumed to be the default value (600) -
type(String) : Record typeSupported values
DNS Record type Possible values:RECORD_TYPE_UNSPECIFIED- Record type is not specifiedA-Arecord: IPv4 addressAAAA-AAAArecord: IPv6 addressPTR-PTRrecord: mapping from IP address to a domain nameCNAME-CNAMErecord: an alias for a canonical domain nameMX-MXrecord: mail server information (domain name, priority)TXT-TXTrecord: text data, typically used to verify e-mail addresses, websites and TLS certificatesSRV-SRVrecord: information about a network service (domain name, port, weight)NS-NSrecord: domain name of an authoritative nameserver for this DNS zone, or one of its subzonesSOA-SOArecord: administrative information about this DNS zoneCAA-CAArecord: certificate issuance settings for this DNS zone and its subzonesSVCB-SVCBrecord: service binding. See RFC 9460, section 2.3HTTPS:HTTPSrecord: service binding with HTTPS protocol configuration. See RFC 9460, section 9.1
-
updated_at(String) : Timestamp indicating when the resource was last updated. A string representing a timestamp in ISO 8601 format:YYYY-MM-DDTHH:MM:SSZorYYYY-MM-DDTHH:MM:SS.SSS±HH:MM
Nested Schema for metadata
Nested Schema for status
Read-Only:
effective_fqdn(String) Fully-qualified domain name of this record including.at the end, e.g.www.example.com.reconciling(Boolean) Indicates whether there is a running Operation for this Recordzone_domain_name(String) Domain name of this record’s parent zone including.at the end, e.g.example.com.