modifyShield — Changing the shield

This modifyShield method changes the shield that SiteLock displays on a user 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

    • modifyShield: The method name

    • shield: The shield to be modified

      • site_id: [attribute] - The ID of the site for which to configure the shield

      • language: [attribute] - The language that the badge is displayed in. The full set of languages that this can be displayed in is the set of languages that SiteLock supports in the SiteLock Dashboard.

      • size: [attribute] - The size that the shield can have. The possible values are small, medium, big.

      • color: [attribute] - The primary color of the badge. The possible values are red and white.

      • type: The type of shield to display. You may pass the values that a user is entitled to based on their package. The shield type to which the user is entitled can be found in the getShield response. 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 their plan entitles them to.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyShield>
        <shield site_id="10900" language="en" size="small" color="red" type="mal"/>
    </modifyShield>
</SiteLockOnlineRequest>

Response format

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

    • modifyShield: The method name

Example success response

<SiteLockOnlineResponse>
    <modifyShield/>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <error>size is required</error>
</SiteLockOnlineResponse>