Cache Management

Cache Purge

Allows a cache purge request to be submitted and its status checked. For more details, examples, etc., see the Cache Purge API Guide.

POST /cache/purge

Request to purge content from the proxy cache. 

Parameters

ParameterDescriptionParameter TypeData Type
purgeBodyThe JSON body containing the purge request detailsbody

A purge request JSON object, which has the following general structure:

{
  "purge_request": {
    "action": "string",
    "uris": [
      {
        "uri_pattern": "string",
        "match_mode": "string",
        "cache_key_modifier_regex": "string"
      }
    ]
  }
}

Response Messages

HTTP Status CodeResponse Model
303When cache purge request is successfully submitted
400Malformed JSON data in request
405If HTTP POST method wasn't used
406If Content-Type was not specified in request headers, or was other than application/json
503If there is any other internal error

If successful, a JSON response similar to the following is returned:

{
   "code": 201,
   "description": "OK"
   "purge_response": {
      "transaction_status_uri": "/transactions/67804160"
   }
   "transaction_id": 67804160
}

Transaction Status and Details

Allows retrieving information about the status of a submitted cache purge request.

GET /transactions/{transaction_id}

Requests information about a submitted cache purge request using the transaction_id that the purge request returned.

Parameters

ParameterDescriptionParameter TypeData Type
transaction_idThe JSON body containing the purge request detailspathstring

Response Messages

HTTP Status CodeResponse Model
200When the transaction is pending/succeeded
400If there were any errors with authentication, request parsing, etc.
405If HTTP GET method wasn't used
503If there is some internal error
defaultSuccess