scanInfo — Retrieving the status of SiteLock Scan products

The scanInfo method retrieves the status of various SiteLock scan products for a given site. If you specify the account ID, it will fetch complete scan information for all the sites that belong to 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

    • scaninfo: The method name

      • site_id: The ID of the site for which to retrieve the scan statuses.

        • When a valid site_id value is provided, scanInfo filters its output by this value.

        • When a valid site_id isn’t passed in, then account_id is required and scanInfo return all records for that account, potentially spanning multiple sites.

      • account_id: The ID of the account for which to retrieve the scan statuses.

        • When present, the account ID is used as a filter to return all relevant records.

        • When site_id isn’t present, account_id must be provided.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <scanInfo>
        <site_id>12</site_id>
    </scanInfo>
</SiteLockOnlineRequest>

Response format

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

    • scanInfo: The method name

      • account_id: [attribute] - The ID of the account for which the scan statuses were retrieved.

      • site_id: [attribute] - The ID of the site for which the scan statuses were retrieved.

      • product: The SiteLock product category. There are three categories: Content, Application, and Reputation. Long-standing customers may also see the Infrastructure category in their response, which is deprecated and retained for backwards compatibility.

        • name: [attribute] - The name of the product category.

        • attention_flag: [attribute] - A calculated red/yellow/green flag for the product category. This is only a suggestion for Ul developers and can be ignored. It’s computed from the compliance status of the scans and verifications, excluding Site Health, as follows:

          • Green: This flag will appear if all underlying scan compliance statuses are verified.

          • Yellow: This flag will appear if at least one underlying compliance status is in warning, pending, or provisional status (and nothing is in noncompliant status).

          • Red: This flag will appear if at least one underlying compliance status is non-compliant.

        • feature: (Repeatable) A product feature for which the user is eligible under their current plan.

          • site_health_stage: [attribute] The stage or status of the site’s health. The value can be either of the following:

            • healthy: score = 0

            • at risk: score = 0.01 - 33.32

            • impaired: score = 33.33 - 66.65

            • compromised: score = 66.66 - 100.00

            • analyzing: no scans have run yet

            • unavailable: no scan plan active

          • site_health_score: [attribute] A score representing the site’s health. The score values are mentioned above.

          • type: [attribute] - The type of product feature. The value can be either of the following:

            • scan: A scan product

            • verification: A verification product.

          • code: [attribute] - The product feature. The value can be one of the following:

            • verify_domain_email: Domain email verification.

            • ssl_scan: SSL Monitor

            • malware_scan: Webpage Scan

            • xss_scan: Cross-site scripting scan

            • sqli_scan: SQL injection scan

            • advisories: Security advisories

            • risk_score: Risk Score

            • smart_scan: SMART File Scan

            • db_scan: SMART Database Scan

            • patchman_scan: SMART Patch Scan

            • spam_scan: Spam monitoring

            • verify_phone: (Deprecated) Phone verification. Empty attribute is returned to preserve backwards compatibility.

            • verify_address: (Deprecated) Address verification. Empty attribute is returned to preserve backwards compatibility.

          • name: [attribute] - Text that describes the code attribute.

          • compliance: [attribute] - A compliance status for the scan or verification. The value can be one of the following:

            • pending: The scan hasn’t run yet. The Trust Seal is displayed.

            • warning: The scan found issues, but the user is still within the 3-day grace period to resolve them. The Trust Seal is displayed.

            • noncompliant: The scan found that at least one issue remains unresolved after the 3-day grace period (the status was warning before). The Trust Seal isn’t displayed.

            • verified: The scan found no issues. For business verification, the business attribute was verified successfully, and the Trust Seal is displayed.

          • attention_flag: [attribute] - A calculated red/yellow/green flag for the product category. This is only a suggestion for Ul developers and can be ignored. It’s computed from the compliance status of the scans and verifications, excluding Site Health, as follows:

            • Green: This flag will appear if all underlying scan compliance statuses are verified.

            • Yellow: This flag will appear if at least one underlying compliance status is in warning, pending, or provisional status (and nothing is in noncompliant status).

            • Red: This flag will appear if at least one underlying compliance status is non-compliant.

          • last_scan: [attribute] - The date of the last scan.

          • issues: [attribute] - The number of issues found during the scan. This attribute isn’t present when the value of the type attribute is verification.

          • total: [attribute] - The total number of scanned pages or files. This attribute isn’t present when the value of the type attribute is verification.

          • last_good_date: [attribute] - The last date on which the scan found no issues. This attribute isn’t present when the value of the type attribute is verification.

          • smart_status: [attribute] - The state of the SMART File Scan. The value can be one of the following:

            • active: The scan is enabled for the site.

            • inactive: The scan is disabled for the site.

            • 911: The scan is run at an increased frequency. This value requires a qualifying plan or add-on. The response returns the SMART File Scan status to the appropriate value after the user’s site is clean, and a certain period has elapsed. Partners aren’t required to return the state of the SMART File Scan to a different value.

          • smart_error: [attribute] - The error encountered during the SMART File Scan. For more information, see Common SMART Scan synchronization errors.

          • patch_status: [attribute] - The status of the SMART Patch Scan. The value can be one of the following:

            • success: The SMART Patch Scan was successful.

            • auto_off: SMART Patch Scan did not scan due to the site settings.

            • failure: SMART Patch Scan failed to successfully complete the scan.

            • na: The scan hasn’t run yet.

            • reverted: The code changed by SMART Patch Scan was reverted to the pre-scan state.

          • db_scan_error: [attribute] - The error encountered during the SMART Database Scan.

          • db_scan_error_code: [attribute] - The code of the error encountered during the SMART Database Scan. For more information, see Backup and SMART Database Scan error codes.

          • db_scan_status: [attribute] - The status of the SMART Database Scan. The value can be one of the following:

            • completed: The scan was successfully completed.

            • N/A: The scan hasn’t run yet.

            • error: An error occurred during the scan. The db_scan_error and db_scan_error_code attributes contain more information.

          • fixed_issues: [attribute] - The total number of issues fixed during the scan.

          • found_issues: [attribute] - The total number of issues found during the scan.

        • platform: The type of the platform on your web server, such as WordPress, Joomla, or Drupal.

Successful response

<SiteLockOnlineResponse>
    <scanInfo site_id="12" account_id="13">
        <product name="Content" attention_flag="red">
            <feature name="Malware Scan" attention_flag="red" code="malware_scan" compliance="noncompliant" issue_links="6" issues="4" last_good_scan="2012-07-30" last_scan="2012-08-02" total="31" total_links="48" type="scan" />
            <feature name="SMART Scan" attention_flag="green" code="smart_scan" compliance="verified" fixed_issues="59" issues="0" last_good_scan="2014-09-15" last_scan="0000-00-00" smart_error="Fatal error: max-retries exceeded" smart_status="active" total="2864" type="scan" />
            <feature name="SMART Patch" attention_flag="green" code="patchman_scan" compliance="verified" last_good_scan="2014-09-15" last_scan="0000-00-00" patch_status="na" type="scan" />
            <feature name="Advisories" attention_flag="green" code="advisories" issues="7" last_good_scan="0000-00-00" last_scan="2012-08-02" total="" type="scan" />
            <feature name="Risk Score" attention_flag="green" code="risk_score" issues="1" last_good_scan="2012-08-01" last_scan="2012-08-02" type="scan" />
            <feature name="SMART Database" attention_flag="green" code="db_scan" compliance="verified" db_scan_error="" db_scan_error_code="" db_scan_status="completed" fixed_issues="0" found_issues="" last_good_scan="2012-07-02" last_scan="2012-08-02" type="scan" />
            <feature name="Site Health" code="site_health" site_health_score="24.75" site_health_stage="at risk" />
        </product>
        <product name="Application" attention_flag="yellow">
            <feature name="Cross-Site Scripting Scan" attention_flag="green" code="xss_scan" compliance="verified" issues="0" last_good_scan="2012-08-02" last_scan="2012-08-02" total="31" type="scan" />
            <feature name="SQL Injection Scan" attention_flag="yellow" code="sqli_scan" compliance="warning" issues="4" last_good_scan="2012-07-29" last_scan="2012-08-02" total="31" type="scan" />
            <feature name="Platform Scan" attention_flag="red" code="platform_scan" compliance="noncompliant" issues="39" last_good_scan="2012-07-29" last_scan="2012-08-02" total="31" type="scan">
            <platform>wordpress</platform>
            </feature>
        </product>
        <product name="Reputation" attention_flag="yellow">
            <feature name="Domain Email Verification" attention_flag="green" code="verify_domain_email" compliance="verified" last_scan="2012-08-02" type="verification" />
            <feature name="Spam Monitoring" attention_flag="green" code="spam_scan" compliance="verified" issues="0" last_good_scan="2012-08-02" last_scan="2012-08-02" total="2" type="scan" />
            <feature name="SSL Certificate Check" attention_flag="yellow" code="ssl_scan" compliance="pending" issues="1" last_good_date="0000-00-00" last_scan="2010-05-03" total="1" type="scan" />
        </product>
    </scanInfo>
</SiteLockOnlineResponse>

Error response

<SiteLockOnlineResponse>
    <error>bad account</error>
</SiteLockOnlineResponse>

This error message will help to indicate where the issue lies. A complete listing of error responses can be found in Error codes. The most common error is invalid XML, such as unescaped characters or elements that aren’t closed. Other errors would include the attempt to provision a duplicate account, or other account information issues.