scanSummary — Retrieving summary results of SiteLock Scans

The scanSummary method retrieves summary information for the requested scans, for a given site within the provided date range. Currently, scanSummary only returns data for the following scans: SMART File Scan, SMART Patch Scan, Risk Score, Platform Scan, and SMART Database Scan.

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
- scanSummary: The method name
  - site_id: The ID of the site for which to retrieve summary results
  - start_date: The start of the date range for which to retrieve summary results. The format is YYYY-MM-DD.
  - end_date: The end of the date range for which to retrieve summary results The format is YYYY-MM-DD.
  - scans: A list of scans, which contains one or more of the following elements:
    
    smart_scan: SMART File Scan
    
    platform_scan: Platform Scan
    
    db_scan: SMART Database Scan
    
    patchman_scan: SMART Patch Scan
    
    risk_score: Risk Score
If start_date and end_date are both present, then the API honors those dates, otherwise it returns just the last scan.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <scanSummary>
        <site_id>...</site_id>
        <start_date>...</start_date>
        <end_date>...</end_date>
        <scans>
            <smart_scan />
            <platform_scan />
            <db_scan />
            <patchman_scan />
        </scans>
    </scanSummary>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- scanSummary: The method name
  - account_id: [attribute] - The ID of the account for which summary results were retrieved
  - site_id: [attribute] - The ID of the site for which summary results were retrieved
- smart_scans: A list of SMART File Scans
  - smart_scan: (Repeatable) A summary of a SMART File Scan
    
    num_added: [attribute] - The number of files that were added by the user since the last file synchronization.
    
    num_deleted: [attribute] - The number of files that were deleted by the user since the last file synchronization.
    
    num_modified: [attribute] - The number of files that were modified by the user since the last file synchronization.
    
    num_files: [attribute] - The number of files that were processed.
    
    num_cleaned: [attribute] - The number of files that were cleaned.
    
    num_suspicious: [attribute] - The number of files that were found to contain suspicious code.
    
    scanned_date: [attribute] - The timestamp when the scan finished
    
    size_kb: [attribute] - The total size in KB of files that were processed.
    
    status: [attribute] - The compliance status of the scan
    
    sync_status: [attribute] - The status of the file synchronization process
- patchman_scans: A list of SMART Patch Scans
  - patchman_scan: (Repeatable) A summary of the SMART Patch Scan
    
    action: [attribute] - The value can be patch or revert, depending on whether the found vulnerabilities were patched or the files were reverted to the previous state.
    
    download_msg: [attribute] - The download message
    
    download_status: [attribute] - The download status
    
    num_patched: [attribute] - The number of files that were patched.
    
    num_reverted: [attribute] - The number of files that were reverted.
    
    num_vulnerable: [attribute] - The number of files that were found to contain malicious code.
    
    patch_msg: [attribute] - The message from SMART Patch
    
    patch_status: [attribute] - The status of SMART Patch
    
    scanned_at: [attribute] - The timestamp when the scan finished
    
    smart_scan_id: [attribute] - The ID of the scan
    
    status: [attribute] - The compliance status
    
    sync_msg: [attribute] - The message from the file synchronization process
    
    sync_status: [attribute] - The status of the file synchronization process
    
    upload_status: [attribute] - The status of the files that were uploaded.
- platform_scan: (Repeatable) A summary of the Platform scan
  - id: [attribute] - The ID of the scan
  - has_lower_version_certainty: [attribute] - The ability to determine the exact version of platform
  - scanned_at: [attribute] - The date when the scan finished
  - platform: Information about the platform
    
    name: [attribute] - The platform’s name
    
    severity_1: [attribute] - The number of vulnerable files at a low severity level
    
    severity_2: [attribute] - The number of vulnerable files at a medium severity level
    
    severity_3: [attribute] - The number of vulnerable files at a high severity level
    
    severity_4: [attribute] - The number of vulnerable files at a critical severity level
    
    severity_5: [attribute] - The number of vulnerable files at an urgent severity level
- db_scan: (Repeatable) A summary of the SMART Database scan
  - platform: [attribute] - The application platform that uses the database
  - id: [attribute] - The ID of the scan
  - scanned_at: [attribute] - The timestamp when the scan finished
  - err_code: [attribute] - The error code. For more information, see Error codes.
  - page: (Repeatable) Vulnerabilities found in the scanned tables. If the scan found nothing, it won’t have any page elements.
    
    type: [attribute] - The type of data. The value can be one of the following:
    
    found: The vulnerabilities found in your database.
    
    fixed: The vulnerabilities found and fixed in your database.
    
    failed: The vulnerabilities found, but not fixed in your database.
    
    finding: (Repeatable) The number and location of found vulnerabilities
    
    count: [attribute] - The number of found vulnerabilities
    
    type: [attribute] - The type of found vulnerability. The value can be one of the following:
    
    malware: Malware is malicious code that can potentially affect a visitor to your site.
    
    spam_code: Spam code is code that typically consists of HTML that is used to hide links.
    
    spam_link: A spam link is a link to a website that has been marked as spam
    
    table: The name of the table that was scanned
    
    name: [attribute] - The name of the table that was scanned
    
    count [attribute] - The number of rows scanned in the table

Example success response

<SiteLockOnlineResponse>
    <scanSummary site_id="12" account_id="13">
        <smart_scans>
            <smart_scan id="676275" num_added="0" num_cleaned="0" num_deleted="0" num_files="7941" num_malicious="0" num_modified="0" num_suspicious="2" scanned_date="2014-12-12" size_kb="361181" status="verified" sync_duration="1508" sync_msg="" sync_status="complete" />
            <smart_scan id="675086" num_added="0" num_cleaned="0" num_deleted="0" num_files="7941" num_malicious="0" num_modified="0" scanned_date="2014-12-10" size_kb="361181" status="verified" sync_msg="" sync_status="complete" />
        </smart_scans>
        <platform_scan id="6226129" has_lower_version_certainty="no" scanned_at="2014-12-12">
            <platform name="wordpress" severity_1="0" severity_2="15" severity_3="10" severity_4="4" severity_5="1" />
        </platform_scan>
        <platform_scan id="621629" has_lower_version_certainty="no" scanned_at="2014-12-10">
            <platform name="wordpress" severity_1="0" severity_2="15" severity_3="10" severity_4="4" severity_5="1" />
        </platform_scan>
        <db_scan platform="wordpress" id="40" scanned_at="2019-02-01 14:16:54">
            <page type="fixed">
                <finding count="47" type="malware" />
                <table name="wp5_posts" count="36" />
            </page>
            <page type="found">
                <finding count="95" type="malware" />
                <finding count="24" type="spam_code" />
                <finding count="31" type="spam_link" />
                <table name="wp5_comments" count="15" />
                <table name="wp5_posts" count="24" />
                <table name="wp5_users" count="4" />
            </page>
        </db_scan>
        <db_scan platform="wordpress" id="41" scanned_at="2019-02-04 14:16:54">
            <page type="fixed">
                <finding count="47" type="malware" />
                <table name="wp5_posts" count="36" />
            </page>
            <page type="found">
                <finding count="91" type="malware" />
                <finding count="64" type="spam_code" />
                <finding count="31" type="spam_link" />
                <table name="wp5_comments" count="15" />
                <table name="wp5_posts" count="24" />
                <table name="wp5_users" count="4" />
            </page>
        </db_scan>
        <patchman_scans>
            <patchman_scan id="1347144" action="patch" download_msg="" download_status="na" num_patched="0" num_reverted="0" num_vulnerable="0" patch_msg="" patch_status="na" scanned_at="2019-11-23 09:02:44" smart_scan_id="1347144" status="verified" sync_msg="" sync_status="complete" upload_status="na" />
            <patchman_scan id="1346340" action="patch" download_msg="" download_status="na" num_patched="0" num_reverted="0" num_vulnerable="0" patch_msg="" patch_status="na" scanned_at="2019-11-22 09:13:25" smart_scan_id="1346340" status="verified" sync_msg="" sync_status="complete" upload_status="na" />
        </patchman_scans>
    </scanSummary>
</SiteLockOnlineResponse>

Example 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.