Get Zone

Applies To:

Route

Retrieves a zone's properties and describes all of its records.

Request

A request to retrieve a zone is described below.

HTTP Method	Request URI
GET	https://api.edgecast.com/v2/mcc/customers/AccountNumber/dns/routezone?id=ZoneID&name=ZoneName&timestamp=DateTime

Define the following variables when submitting the above request:

VariableA variable represents a value that must be replaced. A variable consists of either a URL segment (e.g., "0001" in /0001/) or a query string value (e.g., "3" in mediaTypes=3).	Description
AccountNumber Required	Replace this variable with a customer account number. This account number may be found in the upper right-hand corner of the MCC.
ZoneID	Replace this variable with the ID of the desired zone. A zone must be identified either through its system-defined ID or name. Make sure that this type of request includes either the idExample: id=1000 or the nameExample: name=myzone.com. query string parameter.
ZoneName	Replace this variable with the name of the desired zone. A zone must be identified either through its system-defined ID or name. Make sure that this type of request includes either the idExample: id=1000 or the nameExample: name=myzone.com. query string parameter.
DateTime	Optional. Retrieve the version of a zone at a given point in time. Replace this variable with the desired date or date/time. Format:YYYY-MM-DDThh:mm:ss Learn more.

Request Headers

This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.

This endpoint only supports JSON.

Request Body

Request body parameters are not required by this endpoint.

Response

The response to the above request includes an HTTP status code, response headers, and a response body.

Status Code

A status code indicates whether the request was successfully performed.

Response Headers

The response for this endpoint only includes standard HTTP response headers.

View common response headers.

Response Body

The response body for a successful request contains the following response parameters for the zone returned by this endpoint:

Name	Data Type	Description
Comment	String	Indicates the comment associated with a zone.
DomainName	String	Indicates a zone's name.
FailoverGroups	Array	This response parameter contains the set of failover groups associated with the zone.
Group	Object	FailoverGroups array This response parameter contains a failover group.
[A\|AAAA\|CNAME]	Array	FailoverGroups array > Group object Each group contains a section for each record type.Records are returned in the following order. A AAAA CNAME This response parameter contains the following information about a record: Health check configuration Properties Primary status If the group does not contain a particular type of record, then that section will remain blank.
HealthCheck	Object	FailoverGroups array > Group object > A\|AAAA\|CNAME array This response parameter describes the health check configuration associated with a record in the group. A null value is returned if a health check configuration has not been defined.
CheckInterval	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the number of seconds between health checks.
CheckTypeId	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies the type of health check by its system-defined ID. Use the Get Available Health Check Types endpoint to retrieve a list of health check types and their IDs.
ContentVerification	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the text that will be used to verify the success of the health check.
EmailNotificationAddress	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies the e-mail address to which health check notifications will be sent.
FailedCheckThreshold	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the number of consecutive times that the same result must be returned before a health check agent will indicate a change in status.
HTTPMethodId	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies an HTTP method by its system-defined ID. An HTTP method is only used by HTTP/HTTPs health checks. Use the Get Available HTTP Methods (Health Checks) endpoint to retrieve a list of HTTP methods and their IDs.
IPAddress	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the IP address (IPv4 or IPv6) to which TCP health checks will be directed.
IPVersion	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies an IP version by its system-defined ID. This IP version is only used by HTTP/HTTPs health checks. Use the Get Available IP Versions (Health Checks) endpoint to retrieve a list of IP versions and their IDs.
PortNumber	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the port to which TCP health checks will be directed.
ReintegrationMethodId	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the method through which an unhealthy server/hostname will be integrated back into a group. Use the Get Available Health Check Reintegration Methods endpoint to retrieve a list of reintegration methods and their IDs.
Status	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the server/hostname's health check status by its system-defined ID.
StatusName	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the server/hostname's health check status. Valid values are: Success Failed AdminDown Unknown View status definitions in the Route Help Center.
Uri	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the URI to which HTTP/HTTPs health checks will be directed.
IsPrimary	Boolean	FailoverGroups array > Group object > A\|AAAA\|CNAME array Indicates whether the current record is the primary server/hostname to which traffic will be directed.
Record	Object	FailoverGroups array > Group object > A\|AAAA\|CNAME array This response parameter contains the record's properties.
Name	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's name.
Rdata	String	FailoverGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's value.
TTL	Integer	FailoverGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's TTL.
GroupTypeId	Integer	FailoverGroups array Indicates the type of failover group by its system-defined ID. This response parameter will always report "3" which corresponds to zones.
Name	String	FailoverGroups array Indicates the name of the failover group.
LoadBalancingGroups	Array	This response parameter contains the set of load balancing groups associated with the zone.
Group	Object	LoadBalancingGroups array This response parameter contains a load balancing group.
[A\|AAAA\|CNAME]	Array	LoadBalancingGroups array > Group object Each group contains a section for each record type.Records are returned in the following order. A AAAA CNAME This response parameter contains the following information about a record: Health check configuration Properties Load balancing Weight If the group does not contain a particular type of record, then that section will remain blank.
HealthCheck	Object	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array This response parameter describes the health check configuration associated with a record in the group. A null value is returned if a health check configuration has not been defined.
CheckInterval	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the number of seconds between health checks.
CheckTypeId	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies the type of health check by its system-defined ID. Use the Get Available Health Check Types endpoint to retrieve a list of health check types and their IDs.
ContentVerification	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the text that will be used to verify the success of the health check.
EmailNotificationAddress	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies the e-mail address to which health check notifications will be sent.
FailedCheckThreshold	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the number of consecutive times that the same result must be returned before a health check agent will indicate a change in status.
HTTPMethodId	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies an HTTP method by its system-defined ID. An HTTP method is only used by HTTP/HTTPs health checks. Use the Get Available HTTP Methods (Health Checks) endpoint to retrieve a list of HTTP methods and their IDs.
IPAddress	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the IP address (IPv4 or IPv6) to which TCP health checks will be directed.
IPVersion	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Identifies an IP version by its system-defined ID. This IP version is only used by HTTP/HTTPs health checks. Use the Get Available IP Versions (Health Checks) endpoint to retrieve a list of IP versions and their IDs.
PortNumber	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the port to which TCP health checks will be directed.
ReintegrationMethodId	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the method through which an unhealthy server/hostname will be integrated back into a group. Use the Get Available Health Check Reintegration Methods endpoint to retrieve a list of reintegration methods and their IDs.
Status	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the server/hostname's health check status by its system-defined ID.
StatusName	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the server/hostname's health check status.
Uri	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > HealthCheck object Indicates the URI to which HTTP/HTTPs health checks will be directed.
Record	Object	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array This response parameter contains the record's properties.
Name	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's name.
Rdata	String	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's value.
TTL	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array > Record object Indicates the record's TTL.
Weight	Integer	LoadBalancingGroups array > Group object > A\|AAAA\|CNAME array Indicates the load balancing weight assigned to the record.
GroupTypeId	Integer	LoadBalancingGroups array Indicates the type of load balancing group by its system-defined ID. This response parameter will always report "3" which corresponds to zones.
Name	String	LoadBalancingGroups array Indicates the name of the load balancing group.
Records	Object	This response parameter the records associated with the zone. This section only describes records that do not belong to a load balancing or failover group. A null value is returned when the zone does not contain additional records.
RecordType	Array	Records object Each type of record is listed in its own section. Records are returned in the following order. A AAAA CAA CNAME MX NS PTR SPF SRV TXT This response parameter contains all of a zone's records for a given type.
Name	String	Records object > RecordType array Indicates a record's name.
Rdata	String	Records object > RecordType array Indicates a record's value.
TTL	Integer	Records object > RecordType array Indicates a record's TTL.
Status	Integer	Indicates a zone's status by its system-defined ID. Use the Get Available Zone Statuses endpoint to retrieve a list of statuses and their IDs.
Version	Integer	Indicates a zone's version. This version is incremented whenever a change is applied to the zone.
ZoneId	Integer	Identifies a zone by its system-defined ID.
ZoneType	Integer	Indicates a zone's type by its system-defined ID. Use the Get Available Zone Types endpoint to retrieve a list of zone types and their IDs.

Errors

The response body for an unsuccessful request may contain an error parameter that provides additional information.

View common error messages.

Sample Request and Response (JSON)

A sample JSON request is shown below.

GET https://api.edgecast.com/v2/mcc/customers/0001/dns/routezone?id=1234 HTTP/1.1

Authorization: TOK:12345678-1234-1234-1234-1234567890ab

Accept: application/json

Host:api.edgecast.com

A sample JSON response is shown below.

HTTP/1.1 200 OK

Cache-Control: private

Content-Type: application/json; charset=utf-8

Date: Thu, 15 Apr 2021 12:00:00 GMT

Content-Length: 2138

{
	"Comment" : "",
	"DomainName" : "myzone.com.",
	"FailoverGroups" : [{
			"Group" : {
				"A" : [{
						"HealthCheck" : {
							"CheckInterval" : 300,
							"CheckTypeId" : 1,
							"ContentVerification" : "",
							"EmailNotificationAddress" : "joe@mycompany.com",
							"FailedCheckThreshold" : 3,
							"HTTPMethodId" : 1,
							"IPAddress" : "",
							"IPVersion" : 1,
							"PortNumber" : null,
							"ReintegrationMethodId" : 1,
							"Status" : 4,
							"StatusName" : "Unknown",
							"Uri" : "hc.mycompany.com"
						},
						"IsPrimary" : true,
						"Record" : {
							"Name" : "www2",
							"Rdata" : "10.10.10.10",
							"TTL" : 300
						}
					}, {
						"HealthCheck" : {
							"CheckInterval" : 300,
							"CheckTypeId" : 1,
							"ContentVerification" : "",
							"EmailNotificationAddress" : "joe@mycompany.com",
							"FailedCheckThreshold" : 3,
							"HTTPMethodId" : 1,
							"IPAddress" : "",
							"IPVersion" : 1,
							"PortNumber" : null,
							"ReintegrationMethodId" : 1,
							"Status" : 4,
							"StatusName" : "Unknown",
							"Uri" : "hc.mycompany.com"
						},
						"IsPrimary" : false,
						"Record" : {
							"Name" : "www2",
							"Rdata" : "10.10.10.11",
							"TTL" : 300
						}
					}
				],
				"AAAA" : [{
						"HealthCheck" : null,
						"IsPrimary" : true,
						"Record" : {
							"Name" : "www2",
							"Rdata" : "::3",
							"TTL" : 300
						}
					}, {
						"HealthCheck" : null,
						"IsPrimary" : false,
						"Record" : {
							"Name" : "www2",
							"Rdata" : "::2",
							"TTL" : 300
						}
					}
				],
				"CNAME" : []
			},
			"GroupTypeId" : 3,
			"Name" : "www2"
		}
	],
	"LoadBalancingGroups" : [{
			"Group" : {
				"A" : [{
						"HealthCheck" : null,
						"Record" : {
							"Name" : "www3",
							"Rdata" : "10.10.10.12",
							"TTL" : 300
						},
						"Weight" : 50
					}, {
						"HealthCheck" : null,
						"Record" : {
							"Name" : "www3",
							"Rdata" : "10.10.10.14",
							"TTL" : 300
						},
						"Weight" : 50
					}
				],
				"AAAA" : [],
				"CNAME" : []
			},
			"GroupTypeId" : 3,
			"Name" : "www3"
		}
	],
	"Records" : {
		"A" : [{
				"Name" : "cdn",
				"Rdata" : "10.10.10.15",
				"TTL" : 3600
			}, {
				"Name" : "hub",
				"Rdata" : "10.10.10.16",
				"TTL" : 3600
			}, {
				"Name" : "media",
				"Rdata" : "10.10.10.17",
				"TTL" : 3600
			}, {
				"Name" : "www",
				"Rdata" : "10.10.10.18",
				"TTL" : 3600
			}
		],
		"AAAA" : [],
		"CNAME" : [],
		"MX" : [],
		"NS" : [],
		"SPF" : [],
		"SRV" : [],
		"TXT" : []
	},
	"Status" : 2,
	"Version" : 1234567890,
	"ZoneId" : 1234,
	"ZoneType" : 1
}