addWafBlacklistGeo — Adding to the geo blacklist

The geographical ("geo") blacklist may be used to block visitors from specific countries or continents. The addWafBlacklistGeo method adds items to the geo blacklist.

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

    • addWafBlacklistGeo: The method name

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

      • countries: A list of countries to blacklist

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

      • continents: A list of continents to blacklist

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

          It’s not necessary to specify both elements if only one needs to be populated. However, any element specified must be populated with at least one of its respective children.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <addWafBlacklistGeo>
        <site_id>1234567</site_id>
        <countries>
            <country>IR</country>
        </countries>
    </addWafBlacklistGeo>
</SiteLockOnlineRequest>

Response format

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

    • addWafBlacklistGeo: The method name

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

      • geo: A list of blacklisted geographical items

        • countries: A list of blacklisted countries

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

        • continents: A list of blacklisted continents

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

The XML response to addWafBlacklistGeo returns a list of all blacklisted targets in addition to new ones added in the request.

Example response

<SiteLockOnlineResponse>
    <addWafBlacklistGeo>
        <exceptions>
        </exceptions>
        <geo>
            <countries>
                <country>AD</country>
                <country>AF</country>
                <country>IE</country>
                <country>IR</country>
            </countries>
        </geo>
    </addWafBlacklistGeo>
</SiteLockOnlineResponse>