purgeWafCache — Clearing the Firewall & CDN cache for a site

The Firewall & CDN portion of the product handles automatic caching of files in order to speed up user websites. If it becomes necessary to clear the cache, it can be done using the purgeWafCache request.

The API endpoint is:

https://api.sitelock.com/v1/partner

Request format

SiteLockOnlineRequest: This element is used to delineate the full API request.
- authentication: The partner’s username, password, and branding
  - username: The partner’s API username
  - password: The partner’s API password
  - partner: (Optional) The brand name to use in messaging
- purgeWafCache: The method name
  - site_id: The ID of the site for which to purge the Firewall & CDN cache
  - purge_pattern: (Optional) If specified, only files matching the pattern are removed

Purge patterns

A purge pattern is any string of literal characters that is searched for within filenames. For example, a pattern of ndex matches index.html and spandex.php. For more fine-grained control, it’s possible to specify the standard Perl Compatible Regular Expressions (PCRE) anchor characters ^ and $ at the beginning and/or end, respectively, of a pattern to anchor to that portion of the string. For example, html$ matches index.html but not learn_html.php.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <purgeWafCache>
        <site_id>1234567</site_id>
        <purge_pattern>.gif$</purge_pattern>
    </purgeWafCache>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- purgeWafCache: The method name
  - status: Either ok or error

Example response

<SiteLockOnlineResponse>
    <purgeWafCache>
        <status>ok</status>
    </purgeWafCache>
</SiteLockOnlineResponse>