addWafWhitelistIPs — Adding to the IP whitelist

The addWafWhitelistIPs method adds IP addresses to the whitelist.

The IP whitelist may be used to allow visitors from particular IP addresses. The IP whitelist is used internally by SiteLock to ensure our scanners are always allowed to access the user’s site. Attempts to add SiteLock scanner IPs to the whitelist are generally ignored as they are already automatically in the whitelist.

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

    • addWafWhitelistIPs: The method name

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

      • ips: A list of IP addresses to whitelist

        • 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>
    <addWafWhitelistIPs>
        <site_id>1234567</site_id>
        <ips>
            <ip>10.2.2.100</ip>
        </ips>
    </addWafWhitelistIPs>
</SiteLockOnlineRequest>

Response format

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

    • addWafWhitelistIPs: The method name

      • ips: A list of whitelisted IP addresses

        • ip: (Repeatable) An IP address

Example response

<SiteLockOnlineResponse>
    <addWafWhitelistIPs>
        <ips>
            <ip>1.2.3.12</ip>
            <ip>10.2.2.100</ip>
        </ips>
    </addWafWhitelistIPs>
</SiteLockOnlineResponse>