Blue Syntax Enzo Help

Enzo Cloud Backup 2.0 - Help

Skip Navigation Links

Enzo Cloud Backup .NET API


Enzo Cloud Backup offers administrators the ability to backup SQL Databases and Azure Tables, along with the capability to perform restore operations either manually or on a defined schedule. If you need further control over the backup and restore operations you can use the Enzo Cloud Backup .NET API and control backup and restore operations directly within your application code. The API provides most of the capabilities of the application itself.


This section of the documentation refers to the Enzo Cloud Backup API which requires a seperate download from the Bluesyntax website. In addition, you must already own a copy of the Enzo Cloud Backup tool before you can use the API because the API relies on configuration settings controlled by the application.

 

Steps to Install and Configure the API

 

  • You will first need to download the Enzo Cloud Backup API from the bluesyntax website at http://www.bluesyntax.net/files/enzobackupapi.zip.
  • Next, run the installer and choose a path where to install the DLLs of the API.
  • Depending on the security settings of your machine, you may need to grant additional access to this folder  
  • Create a new Visual Studio project, and add a reference to the following four DLLs: CloudBackupAPI.dll, EnzoBackupAPI.dll, EnzoDataStorage.dll and EnzoDebug.dll
  • Make sure your project targets .NET Framework 4 (Project Properties under Target Framework)

 

In addition to the steps above, you will need to install and run at least once the Enzo Cloud Backup application so that the necessary configuration settings are created in the cloud. You may also need to deploy a cloud agent if you intend to use the API with cloud agents.


Enzo Cloud Agent
The API allows you to leverage your Enzo Cloud Agents easily; all the operations performed by the API can be asynchronous through the use of a Enzo Cloud Agent. When an operation is started with a cloud agent, you can monitor its progress using the application. Note that your application cannot send messages directly to the cloud agents; it must go through the API.

Message Pipeline
The API also provides a unique mechanism to assist you integrate with your own code: you can optionally indicate to the API that a specific message be sent in an Azure Queue at the completion of the operation. This allows your code to use Azure Queues as a trigger mechanism to perform other tasks. For more information on this feature, check the Integration Pipeline help section.

Enzo Storage Account
When you use constructors to use the API, the API needs to know how to connect to the Enzo storage account that contains the overall configuration settings. This is the same set of credentials that you use when logging in with the application. You can either use registry settings to let the API find the proper Azure connection settings, or provide the Azure credentials as part of the constructor.

API License Key
The API requires a license key to function. The license key to run the API is different than the one used by the application. Please contact info @ bluesyntax.net to obtain an API license key. The license key must be provided as part of the API constructors.