getWafIPBlacklist — Retrieving the IP blacklist

The IP blacklist may be used to block visitors from particular IP addresses. The getWafIPBlacklist method retrieves a list of blacklisted IPs for the site.

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
- getWafIPBlacklist: The method name
  - site_id: The ID of the site for which to retrieve the blacklisted IPs

Example request

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

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getWafIPBlacklist: The method name
  - exceptions: A list of exceptions in the Common exception format
  - ips: A list of blacklisted IPs
    
    ip: (Repeatable) An IP address

Example response

<SiteLockOnlineResponse>
    <getWafIPBlacklist>
        <exceptions>
        </exceptions>
        <ips>
            <ip>1.2.3.12</ip>
        </ips>
    </getWafIPBlacklist>
</SiteLockOnlineResponse>