Getting the bind configuration of a domain¶

Sends a GET request to the endpoint /domains/{id}/bind/{ipTarget}.

Description¶

The Get-Bind-Configuration request allows the user to request the bind configuration of a server of the organisation.

Requirements¶

Values of the request: Domain-ID {id}, IP-Target-Name {ipTarget}

Objects: DomainBindVO

Request¶

To request the bind configuration of a domain, the Domain-ID {id} and the IP-Target-Name {ipTarget} need to be added to the path of the request.

The value for IP-Target-Name depends on the endpoint you want to request.

Use Myra for Myra as the endpoint, or Origin for the customer infrastructure as the endpoint.

As a result, the user gets an object DomainBindVO with the requested information.

The object provides the following information:

Attributes	Description	Values
`domainname`	The name of the domain.	`string`
`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
`primaryDns`	The name server for the domain.	`string`
`hostmaster`	The host for the name server.	`string`
`timeToRefresh`		`integer`
`timeToRetry`		`integer`
`ptimeToExpire`	The validation of the configuration in seconds.	`integer`
`minimumTTL`	The minimum value for TTL.	`integer`
`version`	The version of the configuration.	`integer`
`domain (records)`	The name of the subdomain.	`string`
`ttl (records)`	The time to live in seconds for the DNS records.	`integer`
`type (records)`	The value to identify the type of a DNS record.	`A` `AAAA` `MX` `CNAME` `TXT` DS: the delegation Signer `NS` `SRV`
`value (records)`	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
`cnameAI (records)`	The alternative CNAME that points to the DNS record.
`rtype (records)`	The entry is a name server (dns) or a normal record.
`active (records)`	The availability of the entry.	`true` `false`

Example¶

Example response:

{
  "domainname": "string",
  "ttl": "300",
  "primaryDns": "string",
  "hostmaster": "string",
  "timeToRefresh": 0,
  "timeToRetry": 0,
  "ptimeToExpire": 0,
  "minimumTTL": 0,
  "version": 0,
  "domain (records)": "string",
  "ttl (records)": 0,
  "type (records)": "A",
  "value (records)": "string",
  "cnameAI (records)": "string",
  "rtype (records)": "string",
  "active (records)": true
}

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.