Quick Start Guide

API Basics

API Resources

API: Jobs

Jobs are how backups are scheduled.

  • Partners have access to all Jobs associated with a 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
JobId Integer Read Only
DeviceId Integer Required on POST, otherwise Read Only
Device Object See API Devices
Name String 100 Required
IsInactive Boolean
LastRanOn DateTime Local Read Only
Frequency String Required, must be "Hourly", "Daily", "Weekly", "Monthy", or "One Time".
NextRunOn DateTime Local Required
LateAfter Integer Required, the number of minutes (0 to 1439) past the NextRunOn before a Job is considered to be missed.
Every Integer Required, how often (1 to 999) the Job repeats.
OnMonday Boolean Only applies if the Frequency is "Weekly."
OnTuesday Boolean Only applies if the Frequency is "Weekly."
OnWednesday Boolean Only applies if the Frequency is "Weekly."
OnThursday Boolean Only applies if the Frequency is "Weekly."
OnFriday Boolean Only applies if the Frequency is "Weekly."
OnSaturday Boolean Only applies if the Frequency is "Weekly."
OnSunday Boolean Only applies if the Frequency is "Weekly."
DayOfMonth Integer Only applies if the Frequency is "Monthly."
ExpireOn DateTime Local Only applies if the Frequency is "One Time."
CloudKeepLast Integer Required, the number (0 to 999) of backups to keep stored in the Cloud.
LocalKeepLast Integer Required, the number (0 to 999) of backups to keep stored on the Device.
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention
JobItems Object Read Only, See API Job Items

List (GET)

Returns an array of Jobs in descending order.

URL
https://cleverfoxbackup.com/api/jobs
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
}

Read (GET)

Returns a single Job.

URL
https://cleverfoxbackup.com/api/jobs/{JobId}
Required Parameters
  • JobId
Response Codes
  • 200 OK
  • 404 Not Found
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-21T00: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
      }
    ]
  }
}

Create (POST)

Creates a Job and returns the updated data.

URL
https://cleverfoxbackup.com/api/jobs
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "DeviceId": 1,
    "Name": "Daily Backup",
    "IsInactive": false,
    "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,
    "Token": null
  }
}

Update (PUT)

Updates a Job and returns the updated data.

URL
https://cleverfoxbackup.com/api/jobs/{JobId}
Required Parameters
  • JobId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "Name": "Daily Backup",
    "IsInactive": false,
    "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,
    "Token": null
  }
}

Delete (DELETE)

Deletes a Job.

URL
https://cleverfoxbackup.com/api/jobs/{JobId}
Required Parameters
  • JobId
Response Codes
  • 204 No Content
  • 404 Not Found