Get All Edge CNAMEs - CAN

Allows the retrieval of all edge CNAMEs for the CAN platform.

Request

A request to retrieve a list of edge CNAMEs is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/cnames/adn

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 left-hand corner of the TCC.

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 edge CNAME configuration returned by this endpoint:

Name	Data Type	Description
DirPath	String	Indicates the relative location on the origin server to which the edge CNAME is pointed. If this response parameter is set to blank, then the edge CNAME points to the root folder of the origin server.
EnableCustomReports	Integer	Indicates whether hits and data transferred statistics are being tracked for this edge CNAME. Logged data can be viewed through the Custom Reports module. The only valid value is: 0: Disabled (Default Value). 1: Enabled. CDN activity on this edge CNAME is being logged.
Id	Integer	Indicates the system-defined ID for the edge CNAME.
MediaTypeId	Integer	Indicates the platform on which the edge CNAME configuration resides. This response parameter will always report "14," which is the value assigned to the CAN platform.
Name	String	Indicates the name assigned to the edge CNAME.
OriginId	Integer	Indicates the origin server associated with the edge CNAME. Valid return values are: -1: Indicates that the edge CNAME points to a CDN origin server. CustomerOriginID: Identifies the customer origin server associated with an edge CNAME by its ID.
OriginString	String	Indicates the origin identifier, the account number, and the relative path associated with the edge CNAME. Format: /yyANThis term represents a customer account number. This account number may be found in the upper left-hand corner of the TCC./Path. yy: Indicates the origin identifier (e.g., 00, 80, etc.) associated with the edge CNAME. ANThis term represents a customer account number. This account number may be found in the upper left-hand corner of the TCC.: Indicates the customer account number associated with the edge CNAME. Path: Indicates the relative path to the location on the origin server to which the edge CNAME is pointed. This relative path is also returned by the DirPath response parameter. Customer Origin: If an edge CNAME points to a customer origin server, then this relative path will always start with the name of the customer origin configuration (e.g., /800001/myorigin).

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.

A sample JSON response is shown below.

[{
		"DirPath" : "\/application",
		"EnableCustomReports" : 0,
		"Id" : 139019,
		"MediaTypeId" : 14,
		"Name" : "cdnbanking.example.com",
		"OriginId" : 114197,
		"OriginString" : "\/800001\/banking "
	}, {
		"DirPath" : "",
		"EnableCustomReports" : 0,
		"Id" : 143659,
		"MediaTypeId" : 14,
		"Name" : "cdn.socialmedia.com",
		"OriginId" : -1,
		"OriginString" : "\/000001"
	}
]

Sample Request and Response (XML)

A sample XML request is shown below.

A sample XML response is shown below.

<ArrayOfCustomerCname xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<CustomerCname>
		<DirPath>/application</DirPath>
		<EnableCustomReports>0</EnableCustomReports>
		<Id>139019</Id>
		<MediaTypeId>14</MediaTypeId>
		<Name>cdnbanking.example.com</Name>
		<OriginId>114197</OriginId>
		<OriginString>/800001/banking</OriginString>
	</CustomerCname>
	<CustomerCname>
		<DirPath/>
		<EnableCustomReports>0</EnableCustomReports>
		<Id>143659</Id>
		<MediaTypeId>14</MediaTypeId>
		<Name>cdn.socialmedia.com</Name>
		<OriginId>-1</OriginId>
		<OriginString>/000001</OriginString>
	</CustomerCname>
</ArrayOfCustomerCname>