getWafGeoBlacklist — Retrieving the geo blacklist

The geographical ("geo") blacklist may be used to block visitors from specific countries or continents. The getWafGeoBlacklist method retrieves the geo blacklist for the site.

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

    • getWafGeoBlacklist: The method name

      • site_id: The ID of the site for which to retrieve blacklisted countries and/or continents

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getWafGeoBlacklist>
        <site_id>1234567</site_id>
    </getWafGeoBlacklist>
</SiteLockOnlineRequest>

Response format

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

    • getWafGeoBlacklist: The method name

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

      • geo: A list of 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

Example response

<SiteLockOnlineResponse>
    <getWafGeoBlacklist>
        <exceptions>
        </exceptions>
        <geo>
            <countries>
                <country>AD</country>
                <country>AF</country>
                <country>DZ</country>
            </countries>
        </geo>
    </getWafGeoBlacklist>
</SiteLockOnlineResponse>