getShield — Retrieving information about the shield

The getShield method retrieves information about the shield that the user is entitled to display for a given site. If account_id is specified instead of site_id, then data is returned for each site associated with the account.

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

    • getShield: The method name

      • site_id: (Repeatable) The ID of the site for which you want retrieve the shield configuration. Alternately, instead of site_id, you may pass the account_id element. In this case configuration information is returned for each site under that account.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getShield >
        <site_id>10900</site_id>
    </getShield>
</SiteLockOnlineRequest>

Response format

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

    • getShield: The method name

      • shield: The current configuration of the shield the user is entitled to

        • site_id: [attribute] - The ID of the site

        • language: [attribute] - The language in which the shield is displayed. The supported languages are the same set of languages SiteLock supports on the user dashboard.

        • size: [attribute] - The size in which the shield is displayed.

        • color: [attribute] - The shield’s primary color

        • type: [attribute] - The shield type

        • options: This element delineates the shield configuration options that the user is entitled to. The main option to note is the type. This limits the choice of shield based on the scans that are included in the user’s package.

          • colors: The shield’s primary color. The possible values are red and white.

          • sizes: The available sizes for the shield. The possible values are small, medium, and big.

          • type: The shield type that the user is entitled to. The possible values are:

            • mal: Asserts that the site is malware-free. Basic and Professional plan users are entitled to this shield type.

            • secure: Asserts that the site is both malware-free and free from application vulnerabilities. Premium and Enterprise plan users are entitled to this type of shield. The user may choose to display either shield that they are entitled to.

Example response

<SiteLockOnlineResponse>
    <getShield>
        <shield site_id="10900" language="en" size="small" color="white" type="mal">
            <options>
                <colors>white</colors>
                <colors>red</colors>
                <sizes>small</sizes>
                <sizes>big</sizes>
                <sizes>medium</sizes>
                <type>mal</type>
            </options>
        </shield>
    </getShield>
</SiteLockOnlineResponse>