Quick Start Guide

API Basics

API Resources

API: Log Items

Log Items are the associated Log history of every Job Item.

  • Partners have access to all Log Items associated with any Company account that signed up for CleverFox Backup using a special Partner Plan link.

Attributes

All of the attribute fields are returned from GET (read) operations. Only those attributes not marked as read only may be set via POST (create) or PUT (update) operations.

Name Type Notes
LogItemId Integer Read Only
LogId Integer Read Only
JobItemId Integer Read Only
Name String Read Only
EngineId String Read Only
BaseFolder String Read Only
IncludeSubFolders Boolean Read Only
SearchPatterns String Read Only
ExcludeFolders String Read Only
ExcludePatterns String Read Only
NoCompressExtensions String Read Only
ServerName String Read Only
DatabaseName String Read Only
Port Integer Read Only
AuthenticationMode String Read Only
ServerVersion String Read Only
ServerEdition String Read Only
OptionCompress Boolean Read Only
OptionCopyOnly Boolean Read Only
OptionLogOnly Boolean Read Only
BackupFolder String Read Only
BackupFileName String Read Only
BackupFileSize Integer Read Only
BackupListName String Read Only
BackupListSize Integer Read Only
BackupListCount Integer Read Only
Url String Read Only, a temporary URL for downloading the Backup File/List. Important, this property only appears when the Download Backup File or Download Backup List methods are called.
Expires DateTime UTC Read Only, the date and time when the temporary URL expires. Important, this property only appears when the Download Backup File or Download Backup List methods are called.
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only

List (GET)

Returns an array of Log Items in descending order.

URL
https://cleverfoxbackup.com/api/logitems
Optional Parameters
  • PageNo: the page number to return, defaults to 1.
  • PageSize: the maximum number of records per page, defaults to 25.
Response Codes
  • 200 OK
Sample JSON 
{
  "data": [
    {
      "LogItemId": 1,
      "LogId": 1,
      "JobItemId": 1,
      "Name": "My Application",
      "EngineId": "FILE",
      "EngineType": "File",
      "BaseFolder": "C:\Program Files\My Application",
      "IncludeSubFolders": true,
      "SearchPatterns": "*.*",
      "ExcludeFolders": null,
      "ExcludePatterns": null,
      "NoCompressExtensions": null,
      "ServerName": null,
      "DatabaseName": null,
      "Port": null,
      "AuthenticationMode": "W",
      "ServerVersion": null,
      "ServerEdition": null,
      "OptionCompress": false,
      "OptionCopyOnly": false,
      "OptionLogOnly": false,
      "BackupFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Backup\Job1.JobItem1",
      "BackupFileName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.ZIP",
      "BackupFileSize": 1073741824,
      "BackupListName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.JSON",
      "BackupListSize": 2048,
      "BackupListCount": 256,
      "AddedOn": "2015-01-01T00:00:00.000",
      "UpdatedOn": null
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Log Item.

URL
https://cleverfoxbackup.com/api/logitems/{LogItemId}
Required Parameters
  • LogItemId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "LogItemId": 1,
    "LogId": 1,
    "JobItemId": 1,
    "Name": "My Application",
    "EngineId": "FILE",
    "EngineType": "File",
    "BaseFolder": "C:\Program Files\My Application",
    "IncludeSubFolders": true,
    "SearchPatterns": "*.*",
    "ExcludeFolders": null,
    "ExcludePatterns": null,
    "NoCompressExtensions": null,
    "ServerName": null,
    "DatabaseName": null,
    "Port": null,
    "AuthenticationMode": "W",
    "ServerVersion": null,
    "ServerEdition": null,
    "OptionCompress": false,
    "OptionCopyOnly": false,
    "OptionLogOnly": false,
    "BackupFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Backup\Job1.JobItem1",
    "BackupFileName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.ZIP",
    "BackupFileSize": 1073741824,
    "BackupListName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.JSON",
    "BackupListSize": 2048,
    "BackupListCount": 256,
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null
  }
}

Create (POST)


Update (PUT)


Delete (DELETE)


Download Backup File (GET)

Returns a single Log Item plus a URL for downloading the backup (ZIP) file.

URL
https://cleverfoxbackup.com/api/logitems/downloadbackupfile/{LogItemId}
Required Parameters
  • LogItemId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "LogItemId": 1,
    "LogId": 1,
    "JobItemId": 1,
    "Name": "My Application",
    "EngineId": "FILE",
    "EngineType": "File",
    "BaseFolder": "C:\Program Files\My Application",
    "IncludeSubFolders": true,
    "SearchPatterns": "*.*",
    "ExcludeFolders": null,
    "ExcludePatterns": null,
    "NoCompressExtensions": null,
    "ServerName": null,
    "DatabaseName": null,
    "Port": null,
    "AuthenticationMode": "W",
    "ServerVersion": null,
    "ServerEdition": null,
    "OptionCompress": false,
    "OptionCopyOnly": false,
    "OptionLogOnly": false,
    "BackupFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Backup\Job1.JobItem1",
    "BackupFileName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.ZIP",
    "BackupFileSize": 1073741824,
    "BackupListName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.JSON",
    "BackupListSize": 2048,
    "BackupListCount": 256,
    "Url": "https://s3.amazonaws.com/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/00000000-0000-0000-0000-000000000000.ZIP?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=9999999999&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "Expires": "2015-01-02T00:00:00.000",
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null
  }
}

Download Backup List (GET)

Returns a single Log Item plus a URL for downloading the backup (JSON) list.

URL
https://cleverfoxbackup.com/api/logitems/downloadbackuplist/{LogItemId}
Required Parameters
  • LogItemId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "LogItemId": 1,
    "LogId": 1,
    "JobItemId": 1,
    "Name": "My Application",
    "EngineId": "FILE",
    "EngineType": "File",
    "BaseFolder": "C:\Program Files\My Application",
    "IncludeSubFolders": true,
    "SearchPatterns": "*.*",
    "ExcludeFolders": null,
    "ExcludePatterns": null,
    "NoCompressExtensions": null,
    "ServerName": null,
    "DatabaseName": null,
    "Port": null,
    "AuthenticationMode": "W",
    "ServerVersion": null,
    "ServerEdition": null,
    "OptionCompress": false,
    "OptionCopyOnly": false,
    "OptionLogOnly": false,
    "BackupFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Backup\Job1.JobItem1",
    "BackupFileName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.ZIP",
    "BackupFileSize": 1073741824,
    "BackupListName": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload\Job1.JobItem1_201501010000.JSON",
    "BackupListSize": 2048,
    "BackupListCount": 256,
    "Url": "https://s3.amazonaws.com/XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX/00000000-0000-0000-0000-000000000000.JSON?AWSAccessKeyId=XXXXXXXXXXXXXXXXXXXX&Expires=9999999999&Signature=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "Expires": "2015-01-02T00:00:00.000",
    "AddedOn": "2015-01-01T00:00:00.000",
    "UpdatedOn": null
  }
}