Listing all DNS records of a subdomain¶

Note

To get a list of DNS entries, a domain must already been created.

Sends a GET request to the endpoint /domain/{domainId}/vhost/{vhostId}/dns-records.

Description¶

The List-DNS-Record request allows the user to request a list of all DNS records of a subdomain of the organisation.

Requirements¶

Values of the request: Domain-ID {domainId}, Subdomain-ID {vHostId}

Objects: none

Request¶

To request all DNS records of a subdomain, the Domain-ID {domainId} and the Subdomain-ID {vHostId} need to be added to the path of the request.

As a result, the user gets one or more objects DnsRecordVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`name`	The name of the subdomain of the DNS record. Usually corresponds to the name of the domain or subdomain for which the DNS record is defined.	`string`
`value`	The values in the format of an IP address, name, or text for the DNS entry.	A record: IPv4 address AAAA record: IPv6 address CNAME: a domain name MX: a domain name (no IP) NS: IP address SRV: a domain name TXT: an arbitrary text. DS: the delegation Signer
`priority`	The priority of an MX record.	`integer`
`ttl`	The time to live in seconds.	`300` -> 5 minutes `600` -> 10 minutes `900` -> 15 minutes `1800` -> 30 minutes `3600` -> 1 hour `7200` -> 2 hours `18000` -> 5 hours `43200` -> 12 hours `86400` -> 1 day
`vhostId`	The ID of the subdomain to which the DNS entry is assigned.	`integer`
`recordType`	The value to identify the type of a DNS record.	`A` `AAAA` `MX` `CNAME` `TXT` DS: the delegation Signer `NS` `SRV`
`weight`	The weight of the SRV record.	`integer`
`port`	The server port on the SRV record.	`integer`
`active`	Define whether the domain or subdomain should be protected by Myra or not.	`true` `false`
`sslCertTemplate`		`Null` `string`
`upstreamOptions`	An array with one or more objects `UpstreamOptionsVO` with information about the load balancing settings.	`UpstreamOptionsVO`
`alternativeCname`	The alternative CNAME that points to the DNS record.	`string`
`caaFlags`	The default value is 0. If you specify 1, validation is blocked when the tag of the CA is unknown.	`string`
`caaTag`	Shows one of the following options: `issue`: The CA is authorised to issue a certificate for the domain `issuewild`: The CA may issue wildcard certificates for the domain `iodef`: The URL via which the CA can send an error message in the Incident Object Description Exchange Format.	String
`endpoints`	The public Myra IPv4 address and IPv6 address for the DNS record.	array
`serviceType`	The type of the service behind the DNS record.	`1` -> HTTP `2` -> MAIL `3` -> OTHER
`enabled`	The availability of the entry.	`true` `false`
`comment`	An individual comment for the entry.	`string`
`id`	The ID of the entry.	`integer`
`modified`	The last modification date in ISO 8601 format.	`string($date-time)`
`created`	The creation date in ISO 8601 format.	`string($date-time)`

Example¶

Example response:

[
  {
    "objectType": "string",
    "name": "string",
    "value": "string",
    "priority": 0,
    "ttl": 0,
    "vhostId": 0,
    "recordType": "string",
    "weight": 0,
    "port": 0,
    "active": true,
    "paused": true,
    "sslCertTemplate": "string",
    "upstreamOptions": "string",
    "alternativeCname": "string",
    "environment": "string",
    "caaFlags": 0,
    "caaTag": "string",
    "endpoints": "string",
    "serviceType": 0,
    "encryption": "string",
    "identificationNumber": "string",
    "hashType": "string",
    "id": 0,
    "modified": "string",
    "created": "string",
    "enabled": true,
    "comment": "string"
  }
]

Responses¶

The following responses are available:

STATUS CODE	DESCRIPTION
200	The request has succeeded.
400	The request was unsuccessful. The request was invalid or information is missing.
401	The request has not succeeded because the user authentication was incorrect.
403	The request has not succeeded because the user does not have the right permissions.