Rapid Recovery 6.1.2

REST APIs

Intended audience

Rapid Recovery APIs are intended for use by application developers who want to integrate and extend Rapid Recovery in their application, as well as administrators who want to script interactions with the Rapid Recovery Core server.

Working with Rapid Recovery REST APIs

The Rapid Recovery APIs are REST-style APIs, which means that they use HTTP requests to provide access to resources (data entities) through URI paths. Rapid Recovery APIs use standard HTTP methods such as GET, PUT, POST, and DELETE. Because REST APIs are based on open standards, you can use any language or tool that supports HTTP calls.

There are two ways that application developers and administrators can work with Rapid Recovery APIs. They are:

•

Using C# or other .NET languages to directly use Rapid Recovery .NET client DLL files.

•

Communicate directly with the HTTP endpoint to generate your own XML.

The first approach is recommended. The client DLLs are included in the Rapid Recovery SDK. The method for calling Rapid Recovery APIs is consistent with the way you would consume any .NET 4.5X Windows Communication Foundation (WCF) service.

Downloading and viewing Core and Agent APIs

The Rapid Recovery Software Developer Kit (SDK) includes REST APIs for the Rapid Recovery Core and Rapid Recovery Agent components, and samples and supporting files. These contents are contained in the following folders and then compressed as an archive that includes the following components:

Table 319. Components included in the SDK archive

Rapid Recovery Core APIs

Contains APIs to assist developers or administrators to script functions in Rapid Recovery Core. There are 2 sets of service contracts.

Open the CoreWeb.Client HTML file in a web browser to view information for general REST standards. The service contracts are listed. When you click any corresponding hyperlinked uniform resource identifier (URI), the browser opens information in the Core.Contracts/docWeb/ directory. The resulting page shows information for general REST service operations, including methods and descriptions.

Open the Core.Client HTML file in a web browser to view detailed C# information. When you click any hyperlinked service contract (class), the browser opens information in the Core.Contracts/doc/ directory. The resulting page shows detailed information for all C# methods in the selected class.

Agent.Contracts

Rapid Recovery Agent APIs (deprecated)

Contains APIs that developers or administrators can use to manipulate Rapid Recovery Agent on protected machines.

CAUTION: Agent APIs are deprecated and will be removed from a future version of the SDK. Direct manipulation of the Agent APIs is not recommended. Use of these APIs is considered customization and will not be supported. The information is provided in documentation for historical purposes.

Open the AgentWeb.Client HTML file in a web browser to view information for general REST standards.

Open the Agent.Client HTML file in a web browser to view detailed C# information.

AppRecoveryAPISamples

Code samples and dynamic link libraries

AppRecoveryAPISamples contains code samples that are written in C# programming language. These files represent a good starting point to view code snippets if using the APIs to customize your GUI, management systems, and so on.

AppRecoveryAPISamples\Dependencies contains dynamic link library (DLL) files that Rapid Recovery Core uses. The DLLs contain data contracts (types the Core is familiar with) and service contracts (management methods and operations that can be used to force Core do something). If you want to customize your own graphic user interface, or use a management system to work with Rapid Recovery Core, these DLLs are required.