Retrieves an edge CNAME configuration.
A request to retrieve an edge CNAME is described below.
HTTP Method | Request URI |
---|---|
GET |
https://api.transactcdn.com/v2/mcc/customers/AccountNumber/cnames/EdgeCNAMEID |
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 |
---|---|
Required |
|
Required |
Replace this variable with the system-defined ID of the desired edge CNAME configuration. A list of edge CNAME configurations and their corresponding system-defined IDs can be retrieved through the following endpoint: |
This endpointIdentifies a request's connection point to our REST API service. only takes advantage of common request headers.
Request body parameters are not required by this endpoint.
The response to the above request includes an HTTP status code, response headers, and a response body.
A status code indicates whether the request was successfully performed.
The response for this endpoint only includes standard HTTP response headers.
The response body for a successful request contains the following response parameters:
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.
|
Id |
Integer |
Indicates the ID for the edge CNAME. |
MediaTypeId |
Integer |
Indicates the platform associated with the edge CNAME configuration. Valid return values are:
|
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:
|
OriginString |
String |
Indicates the origin identifier, the account number, and the relative path associated with the edge CNAME. Format:
|
The response body for an unsuccessful request may contain an error parameter that provides additional information.
A sample JSON request is shown below.
GET https://api.transactcdn.com/v2/mcc/customers/0001/cnames/123456 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/json
Host:api.transactcdn.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: 192
{
"DirPath" : "\/RelativePath",
"EnableCustomReports" : 0,
"Id" : 123456,
"MediaTypeId" : 14,
"Name" : "images.example.com",
"OriginId" : -1,
"OriginString" : "\/000001\/RelativePath"
}
A sample XML request is shown below.
GET https://api.transactcdn.com/v2/mcc/customers/0001/cnames/123456 HTTP/1.1
Authorization: TOK:12345678-1234-1234-1234-1234567890ab
Accept: application/xml
Host:api.transactcdn.com
A sample XML response is shown 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
Content-Length: 374
<CustomerCname xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<DirPath>/RelativePath</DirPath>
<EnableCustomReports>0</EnableCustomReports>
<Id>123456</Id>
<MediaTypeId>14</MediaTypeId>
<Name>images.example.com</Name>
<OriginId>-1</OriginId>
<OriginString>/000001/RelativePath</OriginString>
</CustomerCname>