getWafClientAppInfo — Retrieving a list of client applications

The getWafClientAppInfo method retrieves the names and ID codes for web-based applications and bots that may be used on the site or may attempt to access the site externally. Web-based applications may be plugin add-ons that retrieve and send data to the site; server-based tools used to access the sites (for example, cURL, wget), or bots that crawl the site for indexing and other purposes. Client applications can be blacklisted to prevent access or whitelisted to allow access when they are routinely blocked by the Firewall & CDN.

The method returns a list of client applications and their ID codes, assigned by the Firewall & CDN.

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

    • getWafClientAppInfo: The method name. Since this request is information only, no other elements or attributes are required.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getWafClientAppInfo />
</SiteLockOnlineRequest>

Response format

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

    • getWafClientAppInfo: The method name

      • clientApps: A list of web-based applications and bots

        • clientApp: (Repeatable) The name and ID code of the web-based application or bot

          • name: The name of the web-based application or bot

          • id: The ID code of the web-based application or bot

Example response

<SiteLockOnlineResponse>
    <getWafClientAppInfo>
        <clientApps>
            <clientApp>
                <name>360webscan</name>
                <id>559</id>
            </clientApp>
            <clientApp>
                <name>WebMoney Advisor Bot</name>
                <id>127</id>
            </clientApp>
            ...
            <clientApp>
                <name>Playstation</name>
                <id>242</id>
            </clientApp>
        </clientApps>
        <status>ok</status>
    </getWafClientAppInfo>
</SiteLockOnlineResponse>