Get All Zones

Applies To:
Route

Returns a list of primary zones. This list may be filtered by:

Request

A request to retrieve zones is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/mcc/customers/AccountNumber/dns/routezones?status=StatusID

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.

StatusID

Replace this variable with the ID for the desired zone status. The response will be filtered by the specified status.

Use the Get Available Zone Statuses endpoint to retrieve a list of zone statuses and their system-defined IDs.

If the response should not be filtered by status, then the status query string parameterstatus=StatusID should not be included in the request URI.

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 each zone returned by this endpoint:

Name Data Type Description

DomainName

String

Identifies a zone by its name.

Status

Integer

Indicates a zone's status by its system-defined ID.

Use the Get Available Zone Statuses endpoint to retrieve a list of zone statuses.

Version

Integer

Indicates a zone's version. This version number is incremented whenever a change is applied to a zone.

ZoneId

Integer

Identifies a zone by its system-defined ID.

ZoneType

Integer

Indicates the type of zone being described.

Use the Get Available Zone Types endpoint to retrieve a list of zone types.

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/routezones 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: 248

[{
		"DomainName" : "myzone.com.",
		"Status" : 2,
		"Version" : 1390352161,
		"ZoneId" : 1234,
		"ZoneType" : 1
	}, {
		"DomainName" : "example.com.",
		"Status" : 2,
		"Version" : 1390352161,
		"ZoneId" : 1235,
		"ZoneType" : 1
	}
]