modifyBackupSettings — Configuring settings for backup

The modifyBackupSettings method configures the backup 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

    • modifyBackupSettings: The method name

      • site_id: The ID of the site for which to modify the backup settings

      • backup_files: The backup website’s files

        • backup_root: The directory where the website is installed.

        • excluded_dirs: The directories excluded from backup

        • excluded_exts: The filename extensions excluded from backup

        • excluded_files: The files excluded from backup

        • exclude_size_kb: The file excluded from backup based on size in kilobytes (KB)

        • ftp_settings: The FTP server settings

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

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

          • ftp_user: The FTP username for the file download process

          • ftp_pw: The FTP password. If you’re using SSH key authentication, pass gen_ssh_key instead.

          • port: Specify if the FTP/SFTP server is running on a non-default port (default ports are 21 for FTP, 22 for SFTP)

          • ftp_timeout: The number of seconds the server should wait before closing the connection

          • gen_ssh_key: Specifies whether to generate an SSH key pair for access through the SFTP protocol. You can omit this element if a key pair already exists. If you’re using password authentication, pass ftp_pw instead. The possible values are:

            • yes: Generate a new SSH key pair.

            • no: (Optional) Use an existing SSH key pair. This value is retained for backwards compatibility.

        • status: The status of the Backup Files service:

          • active: Returns the Backup Files service to an active state after you suspended it

          • inactive: Suspends the Backup Files service

      • backup_db: The website’s database

        • db_host: The hostname or IP address of the database server

        • db_user: The database username

        • db_pw: The database password

        • web_url: The URL of the website. The URL must start with http:// or https://, and must be a domain, subdomain, or subdirectory.

        • root_dir: The directory where the website is installed.

        • selected_schemas: A list of the website’s database schemas to back up

          • schema: The database schema

        • ftp_settings: The FTP server settings

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

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

          • ftp_user: The FTP username

          • ftp_pw: The FTP password

          • port: Specify the port if the FTP/SFTP server is running on a non-default port (the default ports are 21 for FTP, 22 for SFTP)

          • ftp_timeout: The number of seconds the server should wait before closing the connection

          • gen_ssh_key: Specifies whether to generate an SSH key pair for access through the SFTP protocol. You can omit this element if a key pair already exists. The possible values are:

            • yes: Generate a new SSH key pair.

            • no: (Optional) Use an existing SSH key pair. This value is retained for backwards compatibility.

        • status: The status of the Backup Database service

          • active: Returns the Backup Database service to an active state after you suspended it

          • inactive: Suspends the Backup Database service

In backup_db and backup_files, each update can take up to 30 seconds. To avoid a timeout, make separate calls for backup_db and backup_files.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <modifyBackupSettings>
        <site_id>10900</site_id>
        <backup_files>
            <backup_root>./public_html/</backup_root>
            <exclude_dirs>log</exclude_dirs>
            <exclude_dirs>tmp</exclude_dirs>
            <exclude_exts>tar</exclude_exts>
            <exclude_files>error_log</exclude_files>
            <exclude_size_kb>1000</exclude_size_kb>
            <ftp_settings>
                <protocol>ftp</protocol>
                <ftp_host>ftp.ipower.com</ftp_host>
                <ftp_user>john_doe</ftp_user>
                <ftp_pw>doe_124</ftp_pw>
                <port>21</port>
                <ftp_timeout>1800</ftp_timeout>
            </ftp_settings>
            <status>active</status>
        </backup_files>
        <backup_db>
            <db_host>local</db_host>
            <db_user>john_doe</db_user>
            <db_pw>doe_124</db_pw>
            <web_url>https://example.com</web_url>
            <root_dir>public_html/</root_dir>
            <selected_schemas>
                <schema>vulnerable_wrdp10</schema>
            </selected_schemas>
            <ftp_settings>
                <protocol>ftp</protocol>
                <ftp_host>ftp.ipower.com</ftp_host>
                <ftp_user>john_doe</ftp_user>
                <ftp_pw>doe_124</ftp_pw>
                <port>21</port>
                <ftp_timeout>1800</ftp_timeout>
            </ftp_settings>
            <status>active</status>
        </backup_db>
    </modifyBackupSettings>
</SiteLockOnlineRequest>

Response format

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

    • modifyBackupSettings: The method name

      • backup_files: The backup website’s files

        • backup_root: The directory where the website is installed

        • exclude_dirs: The directories excluded from backup

        • exclude_exts: The filename extensions excluded from backup

        • exclude_files: The files excluded from backup

        • exclude_size_kb: The file excluded from backup based on size in kilobytes (KB)

        • ftp_settings: The FTP settings

          • connection_status: The connection status. The value can be ok or failed.

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

          • ftp_timeout: The number of seconds the server waits before closing the connection

          • ftp_user: The FTP username

          • port: The port that the FTP/SFTP server is running on

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

          • connection_err_msg: This element is present if the request failed. The possible values are:

            • no_dir: The requested directory wasn’t found on the FTP server.

            • bad_conn_max_retries: SiteLock reached the maximum number of connection retry attempts.

            • get_pass_failed: SiteLock couldn’t get access to the FTP server because of invalid credentials.

            • bad_name: SiteLock couldn’t find the FTP server or connect to it.

            • access_denied: SiteLock was denied access to the FTP server.

            • cannot_upload_file: SiteLock doesn’t have the write permission on the FTP server

          • warning: This element is present if modifyBackupSettings returned an error and the site has SMART product. The possible values are:

            • no_dir: The requested directory wasn’t found on the FTP server.

            • bad_conn_max_retries: SiteLock reached the maximum number of connection retry attempts.

            • get_pass_failed: SiteLock couldn’t get access to the FTP server because of invalid credentials.

            • bad_name: SiteLock couldn’t find the FTP server or connect to it.

            • access_denied: SiteLock was denied access to the FTP server.

            • cannot_upload_file: SiteLock doesn’t have the write permission on the FTP server.

          • ssh_pub_key: An SSH public key. This element is present when gen_ssh_key was passed in to generate an SSH key pair for access through the SFTP protocol.

        • pending_backup: This element is present when a file backup event is pending or in progress. No backup or SMART configuration settings can be changed while pending_backup returns 1.

        • status: The status of the Backup Files service:

          • active: The Backup Files service is active.

          • inactive: The Backup Files service is suspended: either its settings have errors or it was manually suspended.

          • error: There’s an error in the configuration.

        • message: The error message. This element is present when the value of status is error.

      • backup_db: The website’s database

        • db_host: The hostname or IP address of the database server

        • db_type: The database type (for example, MySQL)

        • db_user: The database username

        • features: This element is present when the ftp connection succeeds.

          • feature: (Repeatable) A feature

            • name: The features supported on your server. The values can be the following:

              • crypto: Encryption utility available

              • db: Can connect to database

              • fs: File and directory access available

              • gzip: Archive utility available

              • zip: Archive utility available

              • http: Can make outbound HTTP connection

              • json: JSON support available

              • schemas: Able to read database schemas

              • mysqldump: Able to get database information

            • status: Specifies whether the feature is supported

              • ok: The feature is supported.

              • error: The feature isn’t supported.

        • ftp_settings: Similar to above with additional elements:

          • connection_status: The connection status. The value can be ok or failed.

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

          • ftp_timeout: The number of seconds the server waits before closing the connection

          • ftp_user: The FTP username

          • port: The port that the FTP/SFTP server is running on

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

          • connection_err_msg: This element is present if the request failed. The possible values are:

            • no_dir: The requested directory wasn’t found on the FTP server.

            • bad_conn_max_retries: SiteLock reached the maximum number of connection retry attempts.

            • get_pass_failed: SiteLock couldn’t get access to the FTP server because of invalid credentials.

            • bad_name: SiteLock couldn’t find the FTP server or connect to it.

            • access_denied: SiteLock was denied access to the FTP server.

            • cannot_upload_file: SiteLock doesn’t have the write permission on the FTP server

          • warning: This element is present if modifyBackupSettings returned an error and the site has SMART product. The possible values are:

            • no_dir: The requested directory wasn’t found on the FTP server.

            • bad_conn_max_retries: SiteLock reached the maximum number of connection retry attempts.

            • get_pass_failed: SiteLock couldn’t get access to the FTP server because of invalid credentials.

            • bad_name: SiteLock couldn’t find the FTP server or connect to it.

            • access_denied: SiteLock was denied access to the FTP server.

            • cannot_upload_file: SiteLock doesn’t have the write permission on the FTP server

          • ssh_pub_key: An SSH public key. This element is present when gen_ssh_key was passed in to generate an SSH key pair for access through the SFTP protocol.

        • pending_backup: This element is present when a database backup event is pending or in progress. No backup or SMART configuration settings can be changed while pending_backup returns 1.

        • root_dir: The directory where the website is installed.

        • web_url: The URL of the website. The URL must start with http:// or https://, and must be a domain, subdomain, or subdirectory.

        • schemas_list: A list of database schemas available

          • schema: (Repeatable) The database schema

        • selected_schemas: A list of database schemas to back up

          • schema: (Repeatable) The database schema

        • status: The status of the Backup Database service:

          • active: The Backup Database service is active.

          • inactive: The Backup Database service is suspended: either its settings have errors or was manually suspended

          • error: There’s an error in the configuration.

        • message: The error message. This element is present if the value of status is error.

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

The pending_backup element is present when a file or database backup event is pending or in progress. No backup or SMART configuration settings can be changed while pending_backup returns 1.

Example success response

<SiteLockOnlineResponse>
    <modifyBackupSettings>
        <backup_files>
            <backup_root>./public_html/<backup_root>
            <exclude_dirs>log</exclude_dirs>
            <exclude_dirs>tmp</exclude_dirs>
            <exclude_exts>tar</exclude_exts>
            <exclude_files>erro_log</exclude_files>
            <exclude_size_kb>1000</exclude_size_kb>
            <ftp_settings>
                <connection_status>ok</connection_status>
                <ftp_host>ftp.ipower.com</ftp_host>
                <ftp_timeout>1800</ftp_timeout>
                <ftp_user>john_doe</ftp_user>
                <port>21</port>
                <protocol>ftp</protocol>
                <status>active</status>
            </ftp_settings>
            <status>active</status>
        </backup_files>
        <backup_db>
            <db_host>localhost</db_host>
            <db_type>MySQL</db_type>
            <db_user>john_doe</db_user>
            <features>
                <feature>
                    <name>db</name>
                    <status>ok</status>
                </feature>
                <feature>
                    <name>json</name>
                    <status>ok</status>
                </feature>
                ...
            </features>
            <ftp_settings>
                <connection_status>ok</connection_status>
                <ftp_host>ftp.ipower.com</ftp_host>
                <ftp_timeout>1800</ftp_timeout>
                <ftp_user>john_doe</ftp_user>
                <port>21</port>
                <protocol>ftp</protocol>
                <status>active</status>
            </ftp_settings>
            <root_dir>./public_html/</root_dir>
            <web_url>https://example.com/</web_url>
            <schemas_list>
                <schema>sitelock_10</schema>
            </schemas_list>
            <selected_schemas>
                <schema>sitelock_10</schema>
            </selected_schemas>
            <status>active</status>
        </backup_db>
        <site_id>10900</site_id>
    </modifyBackupSettings>
</SiteLockOnlineResponse>

Example error response

<SiteLockOnlineResponse>
    <modifyBackupSettings>
        <backup_files>
          ...
            <ftp_settings>
                <connection_err_msg>get_pass_failed</connection_err_msg>
                <connection_status>failed</connection_status>
                ...
                <status>inactive</status>
                <warning>smart - get_pass_failed</warning>
            </ftp_settings>
            <status>active</status>
        </backup_files>
        <backup_db>
            <ftp_settings>
                <connection_err_msg>get_pass_failed</connection_err_msg>
                <connection_status>failed</connection_status>
                ...
                <status>inactive</status>
            </ftp_settings>
        </backup_db>
        <site_id>10900</site_id>
    </modifyBackupSettings>
</SiteLockOnlineResponse>