getBackupFilesChanged — Retrieving files changed since the previous backup

The getBackupFilesChanged method retrieves the files that changed since the previous backup. The request needs to be made once for each site. The response returns the files changed since the previous backup unless a specific backup_id value is submitted.

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
- getBackupFilesChanged: The method name
  - site_id: The ID of the site for which to manage backups
  - backup_id: The backup ID for which the backup information to retrieve
    
    If no backup_id is provided, the results of the most recent backup are returned.

Example request

<SiteLockOnlineRequest>
    <authentication>
        <user>Username</user>
        <password>Password</password>
    </authentication>
    <getBackupFilesChanged>
        <site_id>10900</site_id>
        <backup_id>1234</backup_id>
    </getBackupFilesChanged>
</SiteLockOnlineRequest>

Response format

SiteLockOnlineResponse: This element is used to delineate the full API response.
- getBackupFilesChanged: The method name
  - action: A container element for the performed operation
    
    files: A list of files
    
    file: (Repeatable) The file information
    
    file_id: The ID of the file
    
    filesize: The file size in KB
    
    path: The file path
    
    type: The type of operation. The value can be one of the following:
    
    added: The files were added since the previous backup.
    
    modified: The files were modified since the previous backup.
    
    deleted: The files were deleted since the previous backup.
  - backup_id: The ID associated with the backup event
    
    No backup_id indicates the results are from the most recent backup.
  - backup_root: The directory where the website is installed.
  - site_id: The ID of the site
  - status: The status of the API call, either ok or error

Example response

<SiteLockOnlineResponse>
    <getBackupFilesChanged>
        <action>
            <files>
                <file>
                    <file_id>1234</file_id>
                    <filesize>28987</filesize>
                    <path>public_html/images/</path>
                <file>
                ...
            </files>
            <type>added</type>
        </action>
        <action>
            <files>
                <file>
                    <file_id>99876</file_id>
                    <filesize>2048</filesize>
                    <path>public_html/scripts/</path>
                <file>
                ...
            </files>
            <type>deleted</type>
        </action>
        <action>
            <files>
                <file>
                    <file_id>55496</file_id>
                    <filesize>3345</filesize>
                    <path>public_html/test_files</path>
                </file>
                ...
            </files>
            <type>modified</type>
        </action>
        <backup_id>420</backup_id>
        <backup_root>./public_html/</backup_root>
        <site_id>10900</site_id>
        <status>ok</status>
    </getBackupFilesChanged>
</SiteLockOnlineResponse>