Get All TSIG Keys - BETA

Applies To:
Route

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

Retrieve a list of TSIG keys and their properties.

Request

A request to retrieve all TSIG keys is described below.

HTTP Method Request URI

GET

https://api.edgecast.com/v2/mcc/customers/AccountNumber/dns/mastertsig

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.

Request Headers

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

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 TSIG key returned by this endpoint:

Name Data Type Description

Id

Integer

Identifies a TSIG key by its system-defined ID.

Alias

String

Indicates a brief description for the TSIG key.

KeyName

String

Identifies the key on the master name server and our Route name servers. This name must be unique.

KeyValue

String

Identifies a hash value through which our name servers will be authenticated to a master name server.

AlgorithmId

Integer

Identifies a cryptographic hash function by its system-defined ID.

AlgorithmName

String

Identifies the cryptographic hash function used to generate the key value.

Valid values are:

  • HMAC-MD5
  • HMAC-SHA1
  • HMAC-SHA256
  • HMAC-SHA384
  • HMAC-SHA224
  • HMAC-SHA512

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/mastertsig HTTP/1.1

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

Accept: application/json

Content-Type: 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: 168

[{
		"Id": 12,
		"Alias": "My TSIG Key",
		"KeyName": "MNSKeyA55",
		"KeyValue": "1234567890abcdefghijkl",
		"AlgorithmId": 1,
		"AlgorithmName": "HMAC-MD5"
	}
]