Quick Start Guide

API Basics

API Resources

API: Job Items

Job Items are the things (i.e. Folders, Databases) that need to get backed up.

  • Partners have access to all Job Items 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
JobItemId Integer Read Only
JobId Integer Required on POST, otherwise Read Only
Name String 100
BackupTypeId Integer Required
BackupType Object See API Backup Types
BaseFolder String 248 Required if the BackupType.EngineType is "File" or "Folder".
IncludeSubFolders Boolean
SearchPatterns String Required if the BackupType.EngineType is "File" or "Folder". Multiple patterns are separated by "\r\n".
ExcludeFolders String Only applies if the IncludeSubFolders is true. Multiple folders are separated by "\r\n".
ExcludePatterns String Multiple patterns are separated by "\r\n".
NoCompressExtensions String Multiple patterns are separated by "\r\n".
ServerName String 50 Required if the BackupType.EngineType is "SqlServer".
DatabaseName String 128 Required if the BackupType.EngineType is "SqlServer".
Port Integer
AuthenticationMode String 10 Required if the BackupType.EngineType is "SqlServer". Must be either "W" for Windows or "S" for SQL Server.
Username String 250 Required if the AuthenticationMode is "S" SQL Server. Not available on a GET request.
Password String 250 Required if the AuthenticationMode is "S" SQL Server. Not available on a GET request.
OptionCompress Boolean
OptionCopyOnly Boolean
OptionLogOnly Boolean
AddedOn DateTime UTC Read Only
UpdatedOn DateTime UTC Read Only
Token String 50 See API Duplication Prevention

List (GET)

Returns an array of Job Items in descending order.

URL
https://cleverfoxbackup.com/api/jobitems
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": [
    {
      "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 Item.

URL
https://cleverfoxbackup.com/api/jobitems/{JobItemId}
Required Parameters
  • JobItemId
Response Codes
  • 200 OK
  • 404 Not Found
Sample JSON 
{
  "data": {
    "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 Item and returns the updated data.

URL
https://cleverfoxbackup.com/api/jobitems
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "JobId": 1,
    "Name": "My Application",
    "BackupTypeId": 1,
    "BaseFolder": "C:\\Program Files\\My Application",
    "IncludeSubFolders": true,
    "SearchPatterns": "*.*",
    "ExcludeFolders": null,
    "NoCompressExtensions": null,
    "ExcludePatterns": null,
    "NoCompressExtensions": null,
    "ServerName": null,
    "DatabaseName": null,
    "Port": null,
    "AuthenticationMode": "W",
    "Username": null,
    "Password": null,
    "OptionCompress": false,
    "OptionCopyOnly": false,
    "OptionLogOnly": false,
    "Token": null
  }
}

Update (PUT)

Updates a Job Item and returns the updated data.

URL
https://cleverfoxbackup.com/api/jobitems/{JobItemId}
Required Parameters
  • JobItemId
Response Codes
  • 200 OK
  • 404 Not Found
  • 409 Conflict
Sample JSON 
{
  "data": {
    "Name": "My Application",
    "BackupTypeId": 1,
    "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,
    "Token": null
  }
}

Delete (DELETE)

Deletes a Job Item.

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