Purge Content

Purging content invalidates the cached version of an asset from our edge servers. By default, the CDN will forward the next request for that content to the origin server.

View purging content tutorial.

Key information:

• There is a default limit of 50 concurrent purge requests. Exceeding this limit will generate a 400 Bad Request.

  All outstanding purge requests count towards this concurrent purge request limit. This includes purge requests submitted via the MCC, the Purge Content endpoint, or the Bulk Purge Content endpoint.

  With regards to bulk purges, each specified URL counts as a separate purge request. For example, each element defined in the MediaPath array of the Bulk Purge Content endpoint counts as a separate purge request.

• An asset should only be purged a single time per platform. The asset will be purged for all CDN and edge CNAME URLs that point to the purge location, regardless of the protocol (i.e., http or https) used to reach it.

  If the purge request is limited to a specific region, then an asset should be purged a single time per unique combination of platform and region.

• An asset only needs to be purged a single time per unique combination of platform and region. The asset will be purged for all CDN and edge CNAME URLs that point to the purge location, regardless of the protocol (i.e., http or https) used to reach it.

• A short period of time may elapse before an asset is completely purged from our entire network. However, a successful request will immediately return an ID in the response. Find out the current status of your purge request(s) by passing this ID to:

  • Purging via Purge Content Endpoint: Get Purge Request endpoint
  • Purging via Bulk Purge Content Endpoint: Get Bulk Purge Request endpoint

More information on purging (including syntax information).

Request

A request to purge content is described below.

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

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 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

Pass the following request body parameters:

Name	Data Type	Description
EdgeNodeRegionIds	Array	Defines the set of regions to which the purge request will be applied. Set this parameter to the desired region ID(s). Use a comma to delimit multiple regions. Regional purging is designed to meet specialized cache management needs. When in doubt, purge content from all regions. Omitting this parameter will apply the purge request to the entire network (i.e., all regions). View example. JSON: EdgeNodeRegionIds: [3,4], XML: <EdgeNodeRegionIds> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">3</int> <int xmlns="http://schemas.microsoft.com/2003/10/Serialization/Arrays">4</int> </EdgeNodeRegionIds> Retrieve a list of regions and their corresponding system-defined IDs through the Get Load/Purge Regions endpoint. Although the response for the Get Load/Purge Regions endpoint includes the POPs (i.e., edge nodes) associated with each region and their system-defined IDs, the EdgeNodeRegionIds request parameter only accepts the system-defined IDs for load/purge regions.
MediaPath Required	String	Identifies the CDN or edge CNAME URL corresponding to the asset or the location that will be purged from our edge servers. Include the protocol (e.g., http://) when specifying this URL. More information on purging (including syntax information). For the purpose of this endpoint, the http:// and https:// protocols are interchangeable.
MediaType Required	Integer	Identifies a delivery platform from which an asset will be purged by its system-defined ID. The only valid value is: 14: Commerce Acceleration Network (CAN)

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 parameter:

Name	Data Type	Description
Id	String	Reports a unique ID assigned to the purge request. Pass this purge ID to the Get Purge Request endpoint to track the status of this purge request.

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.

{
	"MediaPath" : "http:\/\/can.0001.transactcdn.com\/000001\/WebPage.htm",
	"MediaType" : 14
}		

A sample JSON response is provided below.

{
	"Id" : "522e0c33e5671c06c14224d7"
}

Sample Request and Response (XML)

A sample XML request is provided below.

<MediaContentPurge xmlns="http://www.whitecdn.com/schemas/apiservices/">
	<MediaPath>http://can.0001.transactcdn.com/000001/WebPage.htm</MediaPath>
	<MediaType>14</MediaType>
</MediaContentPurge>		

A sample XML response is provided below.

<PurgeId xmlns="http://www.whitecdn.com/schemas/apiservices/" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
	<Id>522e0c98e5671c06c14224d8</Id>
</PurgeId>