addWafBlacklistUrls — Adding to the URL blacklist

The URL blacklist is used to control whether requests are blocked based on the requested URL pattern. The addWafBlacklistUrls adds items to the 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
- addWafBlacklistUrls: The method name
  - site_id: The ID of the site for which to blacklist the URLs
  - url: A list of URLs to blacklist
    
    urls: (Repeatable) The URL to blacklist
    
    path: The URL or URL fragment to blacklist. If pattern is EQUALS, NOT_EQUALS, or PREFIX, the path must begin with a forward slash (/).
    
    pattern: The pattern to match the path against. The value can be one of EQUALS, NOT_EQUALS, CONTAINS, NOT_CONTAINS, PREFIX, and SUFFIX.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <addWafBlacklistUrls>
        <site_id>1234567</site_id>
        <urls>
            <url>
                <path>/SOME/PATH</path>
                <pattern>EQUALS</pattern>
            </url>
            <url>
                <path>admincp</path>
                <pattern>CONTAINS</pattern>
            </url>
        </urls>
    </addWafBlacklistUrls>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- addWafUrlBlacklist: 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 URL or URL fragment. If pattern is EQUALS, NOT_EQUALS, or PREFIX, the path begins with a forward slash (/).
    
    pattern: [attribute] - The pattern to match the path against

Example response

<SiteLockOnlineResponse>
    <addWafBlacklistUrls>
        <exceptions>
        </exceptions>
        <status>ok</status>
        <urls>
            <url path="/SOME/PATH" pattern="EQUALS" />
            <url path="admincp" pattern="CONTAINS" />
        </urls>
    </addWafBlacklistUrls>
</SiteLockOnlineResponse>