Get Bulk Purge Request

Retrieves information, including status, about a bulk purge submitted via the Bulk Purge Content endpoint.

Request

A request to retrieve information about a bulk purge request is described below.

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

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.
BulkPurgeID Required	Replace this variable with an integer that identifies a bulk purge request by its ID. This ID is returned by the Bulk 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
Status_Details	Object	Provides information about the bulk purge request.
Count	Integer	Status_Details object Indicates the number of purge requests defined in the bulk purge request.
Status	String	Status_Details object Indicates the status for the purge requests defined in the bulk purge request. Valid values are: in-progress: Indicates that one or more purge requests have not been completed. done: Indicates that all purge requests have been completed.
Created_at	String	Status_Details object Indicates the date and time (UTC) at which the bulk purge request was submitted. Format: MM\/DD\/YYYY hh:mm:ss AM|PM
Completed_at	String	Status_Details object Indicates the date and time (UTC) at which all purge requests defined in the bulk purge request were completed. Format: MM\/DD\/YYYY hh:mm:ss AM|PM A null value is returned when the bulk purge request is still being processed.
Batch_id	String	Status_Details object Identifies a bulk purge request by its unique ID.
Progress	String	Status_Details object Identifies the percentage of purge requests that have been completed.
Completed	Integer	Status_Details object Indicates the number of purge requests that have been completed.

Each element defined in the MediaPath array of the Bulk Purge Content endpoint counts as a separate purge request. For example, a wildcard purge (e.g., http://cdn.example.com/*) is treated as a single 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 shown below.

A sample JSON response is shown below.

{
	"Status_Details": {
		"Count": 30,
		"Status": "in-progress",
		"Created_at": "1\/20\/2022 4:54:59 PM",
		"Completed_at": null,
		"Batch_id": "59ea2a63f4992206a8bfae28",
		"Progress": "0.0",
		"Completed": 0
	}
}