API: Logs
Logs are the history of every Job.
- Partners have access to all Logs 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 |
|---|---|---|
| LogId | Integer | Read Only |
| CompanyId | Integer | Read Only |
| Company | Object | Read Only, See API Companies |
| DeviceId | Integer | Read Only |
| Device | Object | Read Only, See API Devices |
| TimeZoneId | String | Read Only |
| SubscriptionId | Integer | Read Only |
| Subscription | Object | Read Only, See API Subscriptions |
| PlanId | Integer | Read Only |
| Plan | Object | Read Only, See API Plans |
| JobId | Integer | Read Only |
| Job | Object | Read Only, See API Jobs |
| Name | String | Read Only |
| ArchiveFolder | String | Read Only |
| UploadFolder | String | Read Only |
| Frequency | String | Read Only |
| NextRunOn | DateTime Local | Read Only |
| LateAfter | Integer | Read Only |
| ExpireOn | DateTime Local | Read Only |
| LocalKeepLast | Integer | Read Only |
| JobStartedOn | String | Read Only |
| JobCompletedOn | DateTime Local | Read Only |
| JobStatus | String | Read Only |
| ErrorMessages | String | Read Only |
| SendNotificationTo | String | Read Only |
| SendNotificationBcc | String | Read Only |
| SendNotificationCc | String | Read Only |
| SendNotificationOnJobCompleted | Boolean | Read Only |
| SendNotificationOnJobFailed | Boolean | Read Only |
| SendNotificationOnJobMissed | Boolean | Read Only |
| NotificationJobCompletedProcessedOn | DateTime UTC | Read Only |
| NotificationJobFailedProcessedOn | DateTime UTC | Read Only |
| NotificationJobMissedProcessedOn | DateTime UTC | Read Only |
| AddedOn | DateTime UTC | Read Only |
| UpdatedOn | DateTime UTC | Read Only |
| LogItems | Object | Read Only, See API Log Items |
List (GET)
Returns an array of Logs in descending order.
URL
https://cleverfoxbackup.com/api/logs
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
{
"data": [
{
"LogId": 1,
"CompanyId": 1,
"Company": {
"CompanyId": 1,
"PartnerId": 1,
"Partner": null,
"PlanTypeId": 1,
"PlanType": null,
"Name": "ABC Company, Inc.",
"AddressLine1": "1000 Main St",
"AddressLine2": null,
"CityMunicipality": "Anytown",
"StateProvidence": "MI",
"PostalCode": "12345",
"Country": null,
"Phone": null,
"ExternalId": null,
"IsInactive": false,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"DeviceId": 1,
"Device": {
"DeviceId": 1,
"CompanyId": 1,
"Company": null,
"SubscriptionId": 1,
"Subscription": null,
"Name": "Application Server",
"TimeZoneId": "Eastern Standard Time",
"ApplicationId": null,
"ExternalId": null,
"IsInactive": false,
"ApiKey": "00000000-0000-0000-0000-000000000000",
"LastApiCheckAt": "2015-01-01T00:00:00.000",
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnLogCompleted": true,
"SendNotificationOnLogFailed": true,
"SendNotificationOnLogMissed": true,
"AgentDownloadUrl": "https://cleverfoxbackup.com/downloads/agent/CleverFoxBackupAgent.exe",
"LastAgentDownloadCreated": "2015-01-01T00:00:00.000",
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"TimeZoneId": "Eastern Standard Time",
"SubscriptionId": 1,
"Subscription": {
"SubscriptionId": 1,
"CompanyId": 1,
"Company": null,
"PlanId": 1,
"Plan": null,
"ApplicationId": null,
"ExternalId": null,
"IsInactive": false,
"BillingId": 12345678,
"Status": "Active",
"PeriodStart": "2015-01-01T00:00:00.000",
"PeriodEnd": "2015-02-01T12:00:00.000",
"DownloadLimitExpireOn": null,
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnStorageLimit": true,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"PlanId": 1,
"Plan": {
"PlanId": 1,
"PlanTypeId": 1,
"PlanType": null,
"Name": "Small Plan",
"Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
"IsInactive": false,
"DeviceLimit": 1,
"StorageLimit": 25,
"DownloadLimit": false
},
"JobId": 1,
"Job": {
"JobId": 1,
"DeviceId": 1,
"Device": null,
"Name": "Daily Backup",
"IsInactive": false,
"LastRanOn": "2015-01-01T00:00:00.000",
"Frequency": "Daily",
"NextRunOn": "2015-01-02T00:00:00.000",
"LateAfter": 240,
"Every": 1,
"OnMonday": false,
"OnTuesday": false,
"OnWednesday": false,
"OnThursday": false,
"OnFriday": false,
"OnSaturday": false,
"OnSunday": false,
"DayOfMonth": 1,
"ExpireOn": null,
"CloudKeepLast": 30,
"LocalKeepLast": 1,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null,
"JobItems": []
},
"Name": "Daily Backup",
"ArchiveFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Archive",
"UploadFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload",
"Frequency": "Daily",
"NextRunOn": "2015-01-01T00:00:00.000",
"LateAfter": 240,
"ExpireOn": null,
"LocalKeepLast": 1,
"JobStartedOn": "2015-01-01T00:00:00.000",
"JobCompletedOn": "2015-01-01T00:05:00.000",
"JobStatus": "Completed",
"ErrorMessages": "",
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnJobCompleted": true,
"SendNotificationOnJobFailed": true,
"SendNotificationOnJobMissed": true,
"NotificationJobCompletedProcessedOn": "2015-01-01T00:06:00.000",
"NotificationJobFailedProcessedOn": null,
"NotificationJobMissedProcessedOn": null,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"LogItems": [
{
"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.
URL
https://cleverfoxbackup.com/api/logs/{LogId}
Required Parameters
- LogId
Response Codes
- 200 OK
- 404 Not Found
{
"data": {
"LogId": 1,
"CompanyId": 1,
"Company": {
"CompanyId": 1,
"PartnerId": 1,
"Partner": null,
"PlanTypeId": 1,
"PlanType": null,
"Name": "ABC Company, Inc.",
"AddressLine1": "1000 Main St",
"AddressLine2": null,
"CityMunicipality": "Anytown",
"StateProvidence": "MI",
"PostalCode": "12345",
"Country": null,
"Phone": null,
"ExternalId": null,
"IsInactive": false,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"DeviceId": 1,
"Device": {
"DeviceId": 1,
"CompanyId": 1,
"Company": null,
"SubscriptionId": 1,
"Subscription": null,
"Name": "Application Server",
"TimeZoneId": "Eastern Standard Time",
"ApplicationId": null,
"ExternalId": null,
"IsInactive": false,
"ApiKey": "00000000-0000-0000-0000-000000000000",
"LastApiCheckAt": "2015-01-01T00:00:00.000",
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnLogCompleted": true,
"SendNotificationOnLogFailed": true,
"SendNotificationOnLogMissed": true,
"AgentDownloadUrl": "https://cleverfoxbackup.com/downloads/agent/CleverFoxBackupAgent.exe",
"LastAgentDownloadCreated": "2015-01-01T00:00:00.000",
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"TimeZoneId": "Eastern Standard Time",
"SubscriptionId": 1,
"Subscription": {
"SubscriptionId": 1,
"CompanyId": 1,
"Company": null,
"PlanId": 1,
"Plan": null,
"ApplicationId": null,
"ExternalId": null,
"IsInactive": false,
"BillingId": 12345678,
"Status": "Active",
"PeriodStart": "2015-01-01T00:00:00.000",
"PeriodEnd": "2015-02-01T12:00:00.000",
"DownloadLimitExpireOn": null,
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnStorageLimit": true,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null
},
"PlanId": 1,
"Plan": {
"PlanId": 1,
"PlanTypeId": 1,
"PlanType": null,
"Name": "Small Plan",
"Details": "1 Device\r\n25 GB Storage\r\nEmail Support\r\nFree Updates",
"IsInactive": false,
"DeviceLimit": 1,
"StorageLimit": 25,
"DownloadLimit": false
},
"JobId": 1,
"Job": {
"JobId": 1,
"DeviceId": 1,
"Device": null,
"Name": "Daily Backup",
"IsInactive": false,
"LastRanOn": "2015-01-01T00:00:00.000",
"Frequency": "Daily",
"NextRunOn": "2015-01-02T00:00:00.000",
"LateAfter": 240,
"Every": 1,
"OnMonday": false,
"OnTuesday": false,
"OnWednesday": false,
"OnThursday": false,
"OnFriday": false,
"OnSaturday": false,
"OnSunday": false,
"DayOfMonth": 1,
"ExpireOn": null,
"CloudKeepLast": 30,
"LocalKeepLast": 1,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"Token": null,
"JobItems": []
},
"Name": "Daily Backup",
"ArchiveFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Archive",
"UploadFolder": "C:\ProgramData\Forward Thinking Software\CleverFox Backup Agent\Upload",
"Frequency": "Daily",
"NextRunOn": "2015-01-01T00:00:00.000",
"LateAfter": 240,
"ExpireOn": null,
"LocalKeepLast": 1,
"JobStartedOn": "2015-01-01T00:00:00.000",
"JobCompletedOn": "2015-01-01T00:05:00.000",
"JobStatus": "Completed",
"ErrorMessages": "",
"SendNotificationTo": "johnsmith@abccompany.com",
"SendNotificationBcc": null,
"SendNotificationCc": null,
"SendNotificationOnJobCompleted": true,
"SendNotificationOnJobFailed": true,
"SendNotificationOnJobMissed": true,
"NotificationJobCompletedProcessedOn": "2015-01-01T00:06:00.000",
"NotificationJobFailedProcessedOn": null,
"NotificationJobMissedProcessedOn": null,
"AddedOn": "2015-01-01T00:00:00.000",
"UpdatedOn": null,
"LogItems": [
{
"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)
This action is not supported. If called it will return a 405 Method Not Allowed.
Update (PUT)
This action is not supported. If called it will return a 405 Method Not Allowed.
Delete (DELETE)
Deletes a Log.
URL
https://cleverfoxbackup.com/api/logs/{LogId}
Required Parameters
- LogId
Response Codes
- 204 No Content
- 404 Not Found