getSMARTDatabase — Retrieving SMART Database Scan configuration settings
The getSMARTDatabase
method retrieves the current SMART Database Scan 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
-
-
getSMARTDatabase: The method name
-
site_id: The ID of the site for which to retrieve the settings
-
-
Response format
-
SiteLockOnlineResponse: This element is used to delineate the full API response.
-
getSMARTDatabase: The method name
-
ftp_settings: The FTP settings
-
ftp_host: The hostname or IP address of the FTP server
-
ftp_user: The FTP username for the file download process. For security purposes, the FTP user password isn’t returned.
-
port: The port that the FTP/SFTP server is running on
-
protocol: The file transfer protocol. The possible values are
ftp
,sftp
, andftps
. -
ssh_pub_key: An SSH public key. This element is present when an SSH key pair exists on SiteLock for access through the SFTP protocol.
-
status: The value can be
active
orinactive
.
-
-
malware: Determines if the user is warned of malicious code or if the code is fixed. The possible values are
fix
andwarn
. The default value iswarn
. -
spam_code: Determines if the user is warned of spam code (HTML hiding malicious links/URLs) or if the code is fixed. The possible values are
fix
andwarn
. The default value iswarn
. -
spam_link: Determines if the user is warned of spam links (a link to a website that has been marked as spam) or if the link is fixed. The possible values are
fix
andwarn
. The default value iswarn
. -
on_version_conflict: Determines the action if a conflict arises when the record has been modified after SiteLock finds the issue, but before SiteLock tries to fix the record. The possible values are
fix
andwarn
. The default value iswarn
. -
platform: The application platform type
-
platform_dir: The directory where the application platform instance is installed.
-
platform_url: The site URL where the application platform site is located.
-
site_id: The ID of the site for which the settings were retrieved
-
spam_link: Determines if the user is warned of spam links (a link to a website that has been marked as spam) or if the link is fixed. The possible values are
fix
andwarn
. The default value iswarn
. -
status: The value can be
active
orinactive
.
-
-
The getSMARTDatabase
may also contain other elements used in modifySMARTDatabase to specify settings.
Example response
<SiteLockOnlineResponse>
<getSMARTDatabase>
<ftp_settings>
<ftp_host>ftp.ipower.com</ftp_host>
<ftp_user>john_doe</ftp_user>
<port>21</port>
<protocol>sftp</protocol>
<ssh_pub_key>...</ssh_pub_key>
<status>active</status>
</ftp_settings>
<malware>warn</malware>
<spam_code>warn</spam_code>
<spam_link>warn</spam_link>
<on_version_conflict>warn</on_version_conflict>
<platform>wordpress</platform>
<platform_dir>public_html/</platform_dir>
<platform_url>https://example.com/</platform_url>
<site_id>10900</site_id>
<spam_link>warn</spamlink>
<status>active</status>
</getSMARTDatabase>
</SiteLockOnlineResponse>