alterWafException — Modifying exceptions to rules

The alterWafException method modifies an exception to rules.

When modifying an exception, all previous exception directives must be passed in again if they are to be preserved. Effectively, modifying an exception is a condensed form of destroying an exception and creating a new one that retains the same ID as the original.

This explanation will assume that the example from the previous section, addWafException, has been executed and is the only exception so executed.

The API endpoint is:

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

Important information about this section is enumerated in the section Standard exception interaction. Please familiarize yourself with that section before reading this one.

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
- alterWafException: The method name
  - site_id: The ID of the site for which to modify the exception
  - exception_id: The ID of the exception. See Common exception format
  - type: The exception type. One item from Exception types
  - ips: A list of IP addresses for which to modify the exception
    
    ip: (Repeatable) An IP address
  - countries: A list of counties for which to modify 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>
    <alterWafException>
        <site_id>1234567</site_id>
        <exception_id>987654</exception_id>
        <type>sql_injection</type>
        <ips>
            <ip>5.4.3.100-5.4.3.120</ip>
        </ips>
        <countries>
            <country>IE</country>
        </countries>
    </alterWafException>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- alterWafException: 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
    
    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
    
    user_agents: A list of user agents that were added
    
    user_agent: (Repeatable) A user agent
    
    status: Either ok or error

Example response

<SiteLockOnlineResponse>
    <alterWafException>
        <exceptions>
            <exception id="987654">
                <geo>
                    <countries>
                        <country>IE</country>
                    </countries>
                </geo>
                <ips>
                    <ip>5.4.3.100-5.4.3.120</ip>
                </ips>
                <user_agents>
                    <user_agent>SpecialSpider/1.11</user_agent>
                </user_agents>
            </exception>
        </exceptions>
        <status>ok</status>
    </alterWafException>
</SiteLockOnlineResponse>