addWafBlacklistIPs — Adding to the IP blacklist

The IP blacklist may be used to block visitors from particular IP addresses. The addWafBlacklistIPs method adds items to the blacklist.

The API endpoint is:

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

Request format

  • SiteLockOnlineRequest

    • 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

    • addWafBlacklistIPs: The method name

      • site_id: The ID of the site for which to blacklist the IPs

      • ips: A list of IP addresses to blacklist

        • ip: (Repeatable) An IP address. The acceptable formats are:

          • A single IP address (for example, 192.168.0.1)

          • A network block in CIDR format (for example, 192.186.0.0/28)

          • An IP address range (for example, 192.168.0.1-192.168.1.30)

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <addWafBlacklistIPs>
        <site_id>1234567</site_id>
        <ips>
            <ip>10.2.2.100</ip>
        </ips>
    </addWafBlacklistIPs>
</SiteLockOnlineRequest>

Response format

  • SiteLockOnlineResponse: This element is used to delineate the full API response.

    • addWafBlacklistIPs: The method name

      • exceptions: A list of exceptions in the Common exception format

      • ips: A list of blacklisted IP addresses

        • ip: (Repeatable) An IP address

Example response

<SiteLockOnlineResponse>
    <addWafBlacklistIPs>
        <exceptions>
        </exceptions>
        <ips>
            <ip>1.2.3.12</ip>
            <ip>10.2.2.100</ip>
        </ips>
    </addWafBlacklistIPs>
</SiteLockOnlineResponse>