getSMARTPatch — Retrieving SMART Patch Scan configuration settings

The getSMARTPatch method retrieves the current SMART Patch Scan configuration settings for a site. SMART Patch Scan is a tool designed to scan and analyze popular content management system (CMS) applications such as WordPress and Joomla. SMART Patch Scan is the main CMS application files, plugins, themes and other add-on modules. SMART Patch Scan seeks out known and potential vulnerabilities in CMS script files, and patches found vulnerabilities or makes specific recommendations on files needing corrections.

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
- getSMARTPatch: The method name
  - site_id: The ID of the site for which to retrieve SMART Patch Scan settings

Example request

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

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getSMARTPatch: The method name
  - auto_fix_app: Determines if the user is warned of malicious code or if the code is fixed. The possible values are:
    
    warn: Scan automatically but don’t patch
    
    fix: Scan and patch automatically
    
    ignore: Turn off scanning
  - feature_status: If the value of feature_status is fix, the auto_fix_app can be fix, warn or ignore.

Example response

<SiteLockOnlineResponse>
    <getSMARTPatch>
        <auto_fix_app>warn</auto_fix_app>
        <feature_status>fix</feature_status>
    </getSMARTPatch>
</SiteLockOnlineResponse>