getWafUrlBlacklist — Retrieving the URL blacklist

The URL blacklist is used to control whether requests are blocked based on the requested URL pattern. For example, all requests to index-secret.html could be blocked, preventing outsiders from accessing the file. Exceptions could then be added to allow access to those satisfying particular conditions.

The getWafUrlBlacklist method retrieves the URL blacklist.

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
- getWafUrlBlacklist: The method name
  - site_id: The ID of the site for which to retrieve the URL blacklist

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getWafUrlBlacklist>
        <site_id>1234567</site_id>
    </getWafUrlBlacklist>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getWafUrlBlacklist: The method name
  - exceptions: A list of exceptions in the Common exception format
  - urls: A list of blacklisted URLs
    
    url: (Repeatable) The blacklisted URL
    
    path: [attribute] - The blacklisted path
    
    The URL path must be unique.
    
    pattern: [attribute] - The pattern to match the path with. The value can be one of EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, PREFIX, SUFFIX.

Example response

<SiteLockOnlineResponse>
    <getWafUrlBlacklist>
        <exceptions>
        </exceptions>
        <urls>
            <url path="/MEEP" pattern="PREFIX" />
        </urls>
    </getWafUrlBlacklist>
</SiteLockOnlineResponse>