API: Devices

Devices are the PCs that will be backed up.

When a new Device is created, please allow up to one minute for the AgentDownloadUrl to be updated with the custom installer URL.
Partners have access to all Devices 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
DeviceId	Integer	Read Only
CompanyId	Integer	Required on POST, otherwise Read Only
Company	Object	See API Companies
SubscriptionId	Integer	Required on POST, otherwise Read Only
Subscription	Object	See API Subscriptions
Name	String 100	Required
TimeZoneId	String 50	Required, See API Time Zones
ApplicationId	String 25	Special code assigned to every Partner account. You should consult with CleverFox Backup Support before changing this value.
ExternalId	String 100	Unique identifier for Partners to identify this Device.
IsInactive	Boolean
ApiKey	String	Read Only
LastApiCheckAt	DateTime Local	Read Only
SendNotificationTo	String	Required if either the SendNotificationOnJobCompleted, SendNotificationOnJobFailed or SendNotificationOnJobMissed are true. Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationBcc	String	Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationCc	String	Accepts multiple email addresses if separated by a colon, a semi-colon, or "\r\n".
SendNotificationOnJobCompleted	Boolean
SendNotificationOnJobFailed	Boolean
SendNotificationOnJobMissed	Boolean
AgentDownloadUrl	String	Read Only. A URL for downloading the CleverFox Backup Agent.
LastAgentDownloadCreated	DateTime UTC	Read Only
AddedOn	DateTime UTC	Read Only
UpdatedOn	DateTime UTC	Read Only
Token	String 50	See API Duplication Prevention

List (GET)

Returns an array of Devices in descending order.

URL

https://cleverfoxbackup.com/api/devices

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": [
    {
      "DeviceId": 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
      },
      "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-01T00: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
      },
      "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,
      "SendNotificationOnJobCompleted": true,
      "SendNotificationOnJobFailed": true,
      "SendNotificationOnJobMissed": 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
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Read (GET)

Returns a single Device.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}

Required Parameters

DeviceId

Response Codes

200 OK
404 Not Found

Sample JSON

{
  "data": {
    "DeviceId": 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
    },
    "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-01T00: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
    },
    "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,
    "SendNotificationOnJobCompleted": true,
    "SendNotificationOnJobFailed": true,
    "SendNotificationOnJobMissed": 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
  }
}

Lookup (GET)

Returns a single Device.

URL

https://cleverfoxbackup.com/api/devices/lookup?ExternalId={ExternalId}

Required Parameters

ExternalId

Response Codes

200 OK
404 Not Found

Sample JSON

{
  "data": {
    "DeviceId": 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
    },
    "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-01T00: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
    },
    "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,
    "SendNotificationOnJobCompleted": true,
    "SendNotificationOnJobFailed": true,
    "SendNotificationOnJobMissed": 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
  }
}

Create (POST)

Creates a Device and returns the updated data.

URL

https://cleverfoxbackup.com/api/devices

Response Codes

200 OK
404 Not Found
409 Conflict

Sample JSON

{
  "data": {
    "CompanyId": 1,
    "SubscriptionId": 1,
    "Name": "Application Server",
    "TimeZoneId": "Eastern Standard Time",
    "ApplicationId": null,
    "ExternalId": null,
    "IsInactive": false,
    "SendNotificationTo": "johnsmith@abccompany.com",
    "SendNotificationBcc": null,
    "SendNotificationCc": null,
    "SendNotificationOnJobCompleted": true,
    "SendNotificationOnJobFailed": true,
    "SendNotificationOnJobMissed": true,
    "Token": null
  }
}

Update (PUT)

Updates a Device and returns the updated data.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}

Required Parameters

DeviceId

Response Codes

200 OK
404 Not Found
409 Conflict

Sample JSON

{
  "data": {
    "Name": "Application Server",
    "TimeZoneId": "Eastern Standard Time",
    "ApplicationId": null,
    "ExternalId": null,
    "IsInactive": false,
    "SendNotificationTo": "johnsmith@abccompany.com",
    "SendNotificationBcc": null,
    "SendNotificationCc": null,
    "SendNotificationOnJobCompleted": true,
    "SendNotificationOnJobFailed": true,
    "SendNotificationOnJobMissed": true,
    "Token": null
  }
}

You do not need to include any of the Object or Read Only fields.

Delete (DELETE)

Deletes a Device.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}

Required Parameters

DeviceId

Response Codes

204 No Content
404 Not Found

Jobs (GET)

Returns an array of Jobs by Device in descending order.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}/jobs

Required Parameters

DeviceId

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": [
    {
      "JobId": 1,
      "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,
        "SendNotificationOnJobCompleted": true,
        "SendNotificationOnJobFailed": true,
        "SendNotificationOnJobMissed": 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
      },
      "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": [
        {
          "JobItemId": 1,
          "JobId": 1,
          "Name": "My Application",
          "BackupTypeId": 1,
          "BackupType": {
            "BackupTypeId": 1,
            "EngineId": "FILE",
            "Name": "File",
            "EngineType": "File",
            "Port": null,
            "IsInactive": false
          },
          "BaseFolder": "C:\Program Files\My Application",
          "IncludeSubFolders": true,
          "SearchPatterns": "*.*",
          "ExcludeFolders": null,
          "ExcludePatterns": null,
          "NoCompressExtensions": null,
          "ServerName": null,
          "DatabaseName": null,
          "Port": null,
          "AuthenticationMode": "W",
          "Username": null,
          "Password": null,
          "OptionCompress": false,
          "OptionCopyOnly": false,
          "OptionLogOnly": false,
          "AddedOn": "2015-01-01T00:00:00.000",
          "UpdatedOn": null,
          "Token": null
        }
      ]
    }
  ],
  "page_no": 1,
  "page_size": 25
}

Logs (GET)

Returns an array of Logs by Device in descending order.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}/logs

Required Parameters

DeviceId

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": [
    {
      "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
}

Execute Get Next Job (POST)

Sends a message to a Device to check for the next scheduled Job now.

URL

https://cleverfoxbackup.com/api/devices/{DeviceId}/ExecuteGetNextJob

Required Parameters

DeviceId

Response Codes

200 OK
404 Not Found

Quick Start Guide

API Basics

API Resources

Attributes

List (GET)

URL

Optional Parameters

Response Codes

Sample JSON

Read (GET)

URL

Required Parameters

Response Codes

Sample JSON

Lookup (GET)

URL

Required Parameters

Response Codes

Sample JSON

Create (POST)

URL

Response Codes

Sample JSON

Update (PUT)

URL

Required Parameters

Response Codes

Sample JSON

Delete (DELETE)

URL

Required Parameters

Response Codes

Jobs (GET)

URL

Required Parameters

Optional Parameters

Response Codes

Sample JSON

Logs (GET)

URL

Required Parameters

Optional Parameters

Response Codes

Sample JSON

Execute Get Next Job (POST)

URL

Required Parameters

Response Codes