getSMART — Retrieving SMART File Scan configuration settings

The getSMART method retrieves the current SMART configuration settings for a 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

    • getSMART: The method name

      • site_id: The SiteLock site ID for which to retrieve the settings

Example request

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

Response format

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

    • getSMART: The method name

      • id: For internal SiteLock use

      • auto_fix: Determines whether SMART should automatically fix the malware that it finds, or just alert the user via the dashboard. The possible values are:

        • fix: Automatically removes malware from infected files and alerts the user

        • warn: Files containing malware are identified, and the user is alerted. However, the malware isn’t removed automatically.

      • created_at: The date and time when the settings were created for this user

      • docroot: The directory where the web files are located. When using the FTP or FTPS protocols, the docroot directory should be relative to the home directory of the FTP account. When using SFTP, we recommend you use the full path from the system root directory to the specific web file directory.

      • error_str: The last error that occurred during the FTP synchronization of the site

      • exclude_dirs: (Repeatable) The directory to exclude from the scan. The directory can exist anywhere in the path under docroot. No forward slash (/) needed.

      • exclude_exts: The types of files to exclude from the scan

      • exclude_files: The files to exclude from the scan by name

      • frequency: The frequency of the scan. The possible values are daily, weekly, monthly, quarterly, continuous and never.

      • ftp_host: The hostname or IP address of the FTP server

      • ftp_timeout: The number of seconds the scan should try to download files before it stops trying and times out.

      • web_url: The domain, subdomain, or subdirectory of the website

      • ftp_err_msg: An error message. This element contains a value when ftp_status is inactive.

      • ftp_user: The FTP username for the file download process. For security purposes, the FTP user password isn’t returned.

      • ftp_api: The URL on the partner’s website which Sitelock can use to retrieve the user’s FTP credentials

      • ftp_status: Specifies whether the user provided the FTP credentials. The possible values are:

        • active: The user provided the FTP credentials and SiteLock was able to connect to the FTP server.

        • inactive: The user didn’t provide the FTP credentials or SiteLock couldn’t connect to the FTP server.

      • ssh_pub_key: An SSH public key. This element contains a value when an SSH key pair exists on SiteLock for access through the SFTP protocol.

      • last_scanned_at: The date and time when the SMART File Scan last ran for this user

      • exclude_size_kb: The maximum size (in kilobytes) of files to be scanned. The default value is 5120.

      • methods: The methods used to download files

        • ftp: Standard FTP download of files

      • parallel: The number of FTP threads allowed to run in parallel

      • port: The port that FTP/FTPS/SFTP is running on.

      • protocol: The file transfer protocol. The possible values are ftp, ftps, and sftp.

      • site_id: The ID of the site for which the settings were retrieved

      • status: The state of the SMART File Scan. The possible values are:

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

      • pending_backup: This element is present when a file backup is queued or in progress. No SMART changes can be made when a file backup is pending.

      • updated_at: The date and time the settings were last updated for this user

Example response

<SiteLockOnlineResponse>
    <getSMART>
        <id>44</id>
        <auto_fix>warn</auto_fix>
        <created_at>2024-02-27 11:05:32</created_at>
        <docroot>/public_html/</docroot>
        <error_str/>
        <exclude_dirs>stats</exclude_dirs>
        <exclude_exts>gz</exclude_exts>
        <exclude_exts>tgz</exclude_exts>
        <exclude_exts>tar</exclude_exts>
        <exclude_files>test.php</exclude_files>
        <frequency>daily</frequency>
        <ftp_host>ftp.ipower.com</ftp_host>
        <ftp_timeout>3600</ftp_timeout>
        <web_url>example.com</web_url>
        <ftp_err_msg/>
        <ftp_user>john_doe</ftp_user>
        <ftp_api/>
        <ftp_status>active</ftp_status>
        <ssh_pub_key/>
        <last_scanned_at>2024-02-29</last_scanned_at>
        <exclude_size_kb>5120</exclude_size_kb>
        <methods>
            <ftp>1</ftp>
        </methods>
        <parallel>1</parallel>
        <pending_backup>1</pending_backup>
        <port></port>
        <protocol>ftp</protocol>
        <site_id>10900</site_id>
        <status>active</status>
        <updated_at>2024-02-29 06:47:43</updated_at>
    </getSMART>
</SiteLockOnlineResponse>