Get Purge Request

Retrieves information about a purge request.

Request

A request to retrieve a purge request is described below.

HTTP Method	Request URI
GET	https://api.transactcdn.com/v2/mcc/customers/AccountNumber/edge/purge/PurgeID

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.
PurgeID Required	Replace this variable with an integer that identifies a purge request by its ID. This ID is returned by the Purge Content endpoint.

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:

Name	Data Type	Description
AccountNumber	String	Indicates the CDN account number associated with the purge request.
CompleteDate	String	Indicates the date and time on which the purge request was completed. Format: YYYY-MM-DD hh:mm Learn more. A null value is returned when the purge request is still being processed.
Id	String	Identifies a purge request by its unique ID.
InDate	String	Indicates the date and time on which the purge request was submitted. Format: YYYY-MM-DD hh:mm Learn more.
MediaPath	String	Indicates the CDN or edge CNAME URL for which a purge request was submitted.
MediaTypeId	Integer	Indicates the service associated with the purge request. The only valid value is: 14: Commerce Acceleration Network (CAN)
Regions	Array	Lists all regions to which the purge request was applied.
Id	Integer	Regions array Identifies a region by its system-defined ID.
Name	String	Regions array Identifies a region by its name.

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.

{
	"AccountNumber" : "0001",
	"CompleteDate" : null,
	"Id" : "522e0c33e5671c06c14224d7",
	"InDate" : "2022-01-08 19:08",
	"MediaPath" : "http:\/\/can.0001.transactcdn.com\/000001\/folder1\/*",
	"MediaTypeId" : 14,
	"Regions" : []
}		

Sample Request and Response (XML)

A sample XML request is shown below.

A sample XML response is shown below.

<Purge xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<AccountNumber>0001</AccountNumber>
	<CompleteDate i:nil="true"/>
	<Id>522e0c33e5671c06c14224d7</Id>
	<InDate>2022-01-08 19:08</InDate>
	<MediaPath>http://can.0001.transactcdn.com/000001/folder1/*</MediaPath>
	<MediaTypeId>14</MediaTypeId>
	<Regions/>
</Purge>