addWafException — Adding exceptions to rules

The addWafException method adds an exception to rules.

Please get familar with the information in Standard exception interaction before reading this page.

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

    • addWafException: The method name

      • site_id: The ID of the site for which to add the exception

      • type: The exception type. One item from Exception types

      • ips: A list of IP addresses for which to add the exception

        • 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)

      • countries: A list of counties for which to add the exception

        • country: (Repeatable) The two-character country code

    The addWafException element may contain one or more items from Element pairs for repeatable types. It’s acceptable to add multiple types into a single exception.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <addWafException>
        <site_id>1234567</site_id>
        <type>sql_injection</type>
        <ips>
            <ip>10.2.2.2</ip>
            <ip>5.4.3.100-5.4.3.110</ip>
        </ips>
        <countries>
            <country>US</country>
        </countries>
    </addWafException>
</SiteLockOnlineRequest>

Response format

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

    • addWafException: The method name

      • exceptions: A list of exceptions

        • exception: (Repeatable) An exception

          • id: [attribute] - The ID of the exception

        • geo: A list of geographical items for which the exceptions were added

          • countries: A list of countries that were added

            • country: (Repeatable) The two-character country code

        • ips: A list of IP addresses that were added

          • ip: (Repeatable) An IP address

        • status: Either ok or error

Example response

<SiteLockOnlineResponse>
    <addWafException>
        <exceptions>
            <exception id="987654">
            <geo>
                <countries>
                    <country>US</country>
                </countries>
            </geo>
            <ips>
                <ip>10.2.2.2</ip>
                <ip>5.4.3.100-5.4.3.110</ip>
            </ips>
            </exception>
        </exceptions>
        <status>ok</status>
    </addWafException>
</SiteLockOnlineResponse>