Getting a replication DNS zone¶

Note

The attribute tsigKey is never returned. The system accepts the key but does not send it back.

Sends a GET request to the endpoint /replication-dns/zones/{id}.

Description¶

The Get-Replication-DNS-Zone request allows the user to request a single replication DNS zone of the organisation.

Requirements¶

Values of the request: Zone-ID {id}

Objects: none

Request¶

To request a replication DNS zone, the Zone-ID {id} needs to be added to the path of the request.

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

The object provides the following information:

Attributes	Description	Values
`zoneName`	The name of the zone as a fully qualified domain name.	`string`
`label`	The label of the entry. It is identical to the value of the attribute `zoneName`.	`string`
`replicationMethod`	The method Myra uses to transfer the zone from the master name server.	`AXFR` `IXFR` `IXFR_UDP`
`masters`	An array with the IP addresses of the master name servers Myra transfers the zone from.	array
`tsigKeyName`	The name of the TSIG key that protects the zone transfer.	`string`
`tsigKeyAlgorithm`	The algorithm of the TSIG key.	`hmac-md5` `hmac-sha1` `hmac-sha224` `hmac-sha256` `hmac-sha384` `hmac-sha512`
`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",
  "zoneName": "string",
  "label": "string",
  "replicationMethod": "string",
  "masters": [
    "string"
  ],
  "tsigKeyName": "string",
  "tsigKeyAlgorithm": "string",
  "id": 0,
  "modified": "string",
  "created": "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.