Add Secondary Zone Group - BETA

Applies To:

Route

This endpoint is currently available as a BETA. Business-critical processes should not depend on this functionality.

Creates a secondary zone group along with its secondary zones.

Request

A request to create a secondary zone group is described below.

HTTP Method	Request URI
POST	https://api.edgecast.com/v2/mcc/customers/AccountNumber/dns/secondarygroup

Define the following variable 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.

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.

Request Headers

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

Request Body

Pass the following request body parameters:

Name	Data Type	Description
Name Required	String	Assigns a name to the new secondary zone group.
ZoneComposition Required	Object	Contains parameters that define the secondary zone group.
MasterGroupId Required	Integer	ZoneComposition object Associates a master server group, as identified by its system-defined ID, with the secondary zone group. Use the Get All Master Server Groups endpoint to retrieve a list of master server groups and their system-defined IDs.
MasterServerTsigs Required	Array	ZoneComposition object Assigns TSIG keys to the desired master name servers in the master server group identified by the MasterGroupId parameter. All master name servers associated with the master server group identified by the MasterGroupId parameter must be specified in this array.
MasterServer Required	Object	ZoneComposition object > MasterServerTsigs array Identifies the master name server to which a TSIG key will be assigned.
Id Required	Integer	ZoneComposition object > MasterServerTsigs array > MasterServer object Identifies a master name server by its system-defined ID. Use the Get Master Server Groups endpoint to retrieve a list of master server groups, their master name servers, and their system-defined IDs.
Tsig Required	Object	ZoneComposition object > MasterServerTsigs array Identifies the TSIG key that will be assigned to the master name server identified by the MasterServer object.
Id	Integer	ZoneComposition object > MasterServerTsigs array > Tsig object Identifies a TSIG key by its system-defined ID. Use the Get All TSIG Keys endpoint to retrieve a list of TSIG keys and their system-defined IDs.
Zones Required	Array	ZoneComposition object Contains the secondary zones that will be associated with this secondary zone group.
Comment Required	String	ZoneComposition object > Zones array This parameter is reserved for future use. Please set this parameter to a blank value.
DomainName Required	String	ZoneComposition object > Zones array Identifies a secondary zone by its zone name (e.g., example.com). Our name servers will request a zone transfer for this zone. Therefore, this name must match the one defined on the master name server(s) associated with this secondary zone group.
Status Required	Integer	ZoneComposition object > Zones array Set this parameter to 1.

Name

Data Type

Description

Name

Required

String

Assigns a name to the new secondary zone group.

ZoneComposition

Required

Object

Contains parameters that define the secondary zone group.

MasterGroupId

Required

Integer

ZoneComposition object

Associates a master server group, as identified by its system-defined ID, with the secondary zone group.

Use the Get All Master Server Groups endpoint to retrieve a list of master server groups and their system-defined IDs.

MasterServerTsigs

Required

Array

ZoneComposition object

Assigns TSIG keys to the desired master name servers in the master server group identified by the MasterGroupId parameter.

All master name servers associated with the master server group identified by the MasterGroupId parameter must be specified in this array.

MasterServer

Required

Object

ZoneComposition object > MasterServerTsigs array

Identifies the master name server to which a TSIG key will be assigned.

Required

Integer

ZoneComposition object > MasterServerTsigs array > MasterServer object

Identifies a master name server by its system-defined ID.

Use the Get Master Server Groups endpoint to retrieve a list of master server groups, their master name servers, and their system-defined IDs.

Tsig

Required

Object

ZoneComposition object > MasterServerTsigs array

Identifies the TSIG key that will be assigned to the master name server identified by the MasterServer object.

Integer

ZoneComposition object > MasterServerTsigs array > Tsig object

Identifies a TSIG key by its system-defined ID.

Use the Get All TSIG Keys endpoint to retrieve a list of TSIG keys and their system-defined IDs.

Zones

Required

Array

ZoneComposition object

Contains the secondary zones that will be associated with this secondary zone group.

Comment

Required

String

ZoneComposition object > Zones array

This parameter is reserved for future use.

Please set this parameter to a blank value.

DomainName

Required

String

ZoneComposition object > Zones array

Identifies a secondary zone by its zone name (e.g., example.com).

Our name servers will request a zone transfer for this zone. Therefore, this name must match the one defined on the master name server(s) associated with this secondary zone group.

Status

Required

Integer

ZoneComposition object > Zones array

Set this parameter to 1.

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:

Name	Data Type	Description
Id	Integer	Indicates the system-defined ID assigned to the new secondary zone group.
Name	String	Indicates the name assigned to the new secondary zone group.
ZoneComposition	Object	Contains parameters that define the secondary zone group.
MasterGroupId	Integer	ZoneComposition object Indicates the system-defined ID for the master server group associated with the secondary zone group.
MasterServerTsigs	Array	ZoneComposition object Lists the TSIG key(s) through which our name servers will authenticate to master name server(s).
MasterServer	Object	ZoneComposition object > MasterServerTsigs array Contains the master name server associated with the TSIG key identified in the Tsig object.
Id	Integer	ZoneComposition object > MasterServerTsigs array > MasterServer object Indicates the system-defined ID for the master name server defined within this object.
IpAddress	String	ZoneComposition object > MasterServerTsigs array > MasterServer object Indicates the IP address for the master name server defined within this object.
Name	String	ZoneComposition object > MasterServerTsigs array > MasterServer object Indicates the name for the master name server defined within this object.
Tsig	Object	ZoneComposition object > MasterServerTsigs array Identifies the TSIG key assigned to the master name server defined by the MasterServer object.
Id	Integer	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates the system-defined ID for the TSIG key.
Alias	String	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates a brief description for the TSIG key.
KeyName	String	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates a unique name for the TSIG key.
KeyValue	String	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates the hash value through which our name servers will authenticate to a master name server.
AlgorithmId	Integer	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates the system-defined ID for the cryptographic hash function used to generate the hash value defined in the KeyValue parameter.
AlgorithmName	String	ZoneComposition object > MasterServerTsigs array > Tsig object Indicates the system-defined name for the cryptographic hash function used to generate the hash value identified in the KeyValue parameter.
Zones	Array	ZoneComposition object Contains the secondary zone(s) associated with this secondary zone group.
Comment	String	ZoneComposition object > Zones array This parameter is reserved for future use.
DomainName	String	ZoneComposition object > Zones array Indicates the name (e.g., example.com) for a secondary zone.
FixedZoneId	Integer	ZoneComposition object > Zones array Indicates the system-defined ID assigned to a secondary zone.
IsCustomerOwned	Boolean	ZoneComposition object > Zones array This parameter is reserved for future use. The only supported value for this parameter is "true."
Status	Integer	ZoneComposition object > Zones array Indicates the secondary zone's status. The only supported value for this parameter is "1."
StatusName	String	ZoneComposition object > Zones array Indicates the secondary zone's status. The only supported value for this parameter is "Active."
ZoneId	Integer	ZoneComposition object > Zones array Identifies the current version of the secondary zone by its system-defined ID. This ID will change whenever the secondary zone is updated.
ZoneType	Integer	ZoneComposition object > Zones array This parameter is reserved for future use. The only supported value for this parameter is "2."

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.

POST https://api.edgecast.com/v2/mcc/customers/0001/dns/secondarygroup HTTP/1.1

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

Accept: application/json

Content-Type: application/json

Host: api.edgecast.com

Content-Length: 313

{
	"Name": "My Secondary Zone Group",
	"ZoneComposition": {
		"MasterGroupId": 75,
		"MasterServerTsigs": [{
				"MasterServer": {
					"Id": 123
				},
				"Tsig": {
					"Id": 12
				}
			}
		],
		"Zones": [{
				"Comment": "",
				"DomainName": "example.com",
				"Status": 1
			}
		]
	}
}

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: 694

{
	"Id": 450,
	"Name": "My Secondary Zone Group",
	"ZoneComposition": {
		"MasterGroupId": 75,
		"MasterServerTsigs": [{
				"MasterServer": {
					"Id": 123,
					"IpAddress": "101.111.12.25",
					"Name": "MNS for external sites"
				},
				"Tsig": {
					"Id": 45,
					"Alias": "My TSIG Key",
					"KeyName": "Key4MNSES",
					"KeyValue": "1234567890abcdefghijkl",
					"AlgorithmId": 1,
					"AlgorithmName": "HMAC-MD5"
				}
			}
		],
		"Zones": [{
				"Comment": "",
				"DomainName": "example.com.",
				"FixedZoneId": 12345,
				"IsCustomerOwned": true,
				"Status": 1,
				"StatusName": "Active",
				"ZoneId": 78901,
				"ZoneType": 2
			}
		]
	}
}