Update Primary Key

Updates the primary Token-Based Authentication key associated with the specified platform. This key is used by our servers to encrypt and decrypt a token value.

The update of a primary key may take up to an hour to take effect. However, a response will be returned immediately.

This endpoint should be used with care. The safest method for updating your primary key is to do so through the Token-Based Authentication page. Continuous access to your content cannot be guaranteed when a backup key is not used.

Request

A request to update a primary key is described below.

HTTP Method Request URI

PUT

https://api.edgecast.com/v2/mcc/customers/AccountNumber/token/key

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

Pass the following request body parameters:

Name Data Type Description

Key

Required

String

Updates the value assigned to the primary Token-Based Authentication key associated with the specified platform. Only alphanumeric characters are supported by this string value.

MediaType

Required

Integer

Indicates the service whose primary key will be updated. It should be replaced with the ID associated with the desired service.

Valid values are:

  • 3: HTTP Large
  • 8: HTTP Small
  • 14: Application Delivery Network (ADN)

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 does not contain a response parameter.

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 provided below.

PUT https://api.edgecast.com/v2/mcc/customers/0001/token/key HTTP/1.1

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

Accept: application/json

Content-Type: application/json

Host:api.edgecast.com

Content-Length: 71

{
	"Key" : "MyPrimaryKeyTBA",
	"MediaType" : 3,
	"MinVersion" : "V3"
}

A sample JSON response is provided 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

Sample Request and Response (XML)

A sample XML request is provided below.

PUT https://api.edgecast.com/v2/mcc/customers/0001/token/key HTTP/1.1

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

Accept: application/xml

Content-Type: application/xml

Host:api.edgecast.com

Content-Length: 155

<TokenKeyParamValues xmlns="http://www.whitecdn.com/schemas/apiservices/">
	<Key>MyPrimaryKeyTBA</Key>
	<MediaType>3</MediaType>
	<MinVersion>V3</MinVersion>
</TokenKeyParamValues>

A sample XML response is provided below.

HTTP/1.1 200 OK

Cache-Control: private

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

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